Metadata-Version: 2.1
Name: snap-console
Version: 1.0.3
Summary: Easy-to-use interactive console for Python
Home-page: https://github.com/Kenneth-LJS/snap-console
Author: Kenneth-LJS
Author-email: kenneth_ljs@live.com
Project-URL: Bug Tracker, https://github.com/Kenneth-LJS/snap-console/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Environment :: Console :: Curses
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Snap Console
Easy-to-use interactive console for Python

-----

## Installation

You can install `Snap console` with pip.

```
pip install snap-console
```

## Getting Started

`Snap console` is built on top of the `curses` library to give you access to powerful console functionality without having to deal with low-level read/writes.

To begin, you can set up the console with the following code:

```py
from snapconsole import SnapConsole

console = SnapConsole()
console.start()
# Handle console commands here
console.stop()
```

`start()` initializes the empty console, and `stop()` resets the console to how it was before. You can also use Python's context manager syntax to use the console:

```py
from snapconsole import SnapConsole

with SnapConsole() as console:
    # Handle console commands here
```

## The console

The console consists of 2 segments: the display and the input box. By default, the logs are aligned to the bottom

```
with SnapConsole() as console:
    console.logs 
```
