Metadata-Version: 2.4
Name: nixscribe
Version: 0.1.1
Summary: A CLI Text Editor that supports Syntax Highlighting for .py, .html, .css and .js files.
Author: mhasanali2010
License-Expression: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rich>=13.5.2
Requires-Dist: prompt_toolkit>=3.0.52
Requires-Dist: pygments>=2.17.1
Dynamic: license-file

# nixscribe — Terminal Text Editor
_By mhasanali2010_

## About nixscribe
nixscribe is a terminal-based text editor written in Python.  
It supports CLI arguments:
- `--create` — create files
- `--read` — view files with syntax highlighting
- `--edit` — edit files with syntax highlighting

Syntax highlighting is supported for Python, HTML, CSS, and JavaScript.  
Editing is powered by `prompt_toolkit`, while viewing uses `rich` for syntax highligh
## Resources
### PyPI Link
https://pypi.org/project/nixscribe
### GitHub Repository
https://github.com/mhasanali2010/nixscribe

## External Dependencies
Stated in `requirements.txt`:
- prompt_toolkit
- rich
- pygments
## Installation
Install using pip:
```bash
pip install nixscribe
```
##  Usage
- To create a file:
    ```bash
    nixscribe --create <path\to\file>
    ```
- To read from a file:
    ```bash
    nixscribe --read <path\to\file>
    ```
- To edit a file:
    ```bash
    nixscribe --edit <path\to\file>
    ```
### Keybinds in Edit Mode
- Ctrl+Q to quit editing without saving.
- Ctrl+S to save without quitting.
- F3 to save & quit.
