Metadata-Version: 2.1
Name: PyTerm-Shell
Version: 0.1.11
Summary: Making an aesthetic minimalist Linux shell in Python
Home-page: https://github.com/MetalKamina/PyTerm
Author: Nick Tsiones
Author-email: ntsiones@gmail.com
License: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# Pyterm
_Making an aesthetic minimalist Linux shell in Python_

Welcome to PyTerm! Pyterm is an aesthetic CLI shell for Unix systems written in Python with the Textual framework.

## Features
- Dynamic content swapping
- Saveable configurations and settings
- Standard Linux commands
- All in a text-based interface straight out of Blade Runner

## Installation

To install, use the pip command
```
pip install pyterm-shell
```
Or download from [source].

## Use
To run PyTerm from the pip installation, simply type
```
PyTerm
```
From source, run
```
python3 Main.py
```

## Warnings
**SOME LINUX PROGRAMS WILL BREAK WHEN RUN THROUGH PYTERM**
These include nano, vim, and most programs that require more than basic console output.
Running these programs is considered undefined behavior and can have a range of untested consequences.

Here's a (very) short list of things you shouldn't do in/with PyTerm:
- Run non-console programs
- Modify/delete any of the files PyTerm needs to function

## Conclusion
PyTerm is a cool project that (should) continue to recieve regular updates. If you find any bugs or have any feature ideas, please make a post [here].

## Liscense
Copyright (c) 2018 The Python Packaging Authority

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


   [source]: <https://github.com/MetalKamina/PyTerm>
   [here]: <https://github.com/MetalKamina/PyTerm/issues>
