Metadata-Version: 2.1
Name: py-notes
Version: 1.0.4
Summary: Take notes directly in your terminal.
Home-page: https://github.com/Saakshaat/notes-cli
License: MIT
Keywords: CLI,Notes,Poetry
Author: Saakshaat
Author-email: saakshaat2001@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=7.1.2,<8.0.0)
Project-URL: Repository, https://github.com/Saakshaat/notes-cli
Description-Content-Type: text/markdown

# notes-cli

A Python based CLI for taking notes from your terminal. 

This application was built using [Click](https://click.palletsprojects.com/), which is a wonderful Python package for building interactive CLIs. 

![Help Page Screenshot](https://imgur.com/vLY8omF.jpg)

# Installation
### PIP
We're published to [PyPI](https://pypi.org/project/py-notes/), which means you can install this package directly through Pip.

`pip install py-notes`

### Local
You must first clone this repository with:
`git clone https://github.com/Saakshaat/notes-cli`

Then, after `cd`ing into its directory, install the executable on your system with:
`pip install --editable .`

If you don't want to have this installed globally, you can run it in a virtual environment. To create a virtual env, go to the repo's directory and on the top-level run
- `virtualenv venv`
- `. venv/bin/activate`
- `pip install --editable .`

# Running

After installing the CLI successfully, you can run it from whichever environment you installed it in with

`notes <command>` 

![show command demo](https://imgur.com/rVSe4Yp.jpg)

 The application uses a SQLite database to save notes in memory and maintains a threshold of (currently) 25 notes. 
 
 When the total number of notes reaches the threshold, it deletes the oldest note in memory before adding the new note.
