Metadata-Version: 2.1
Name: Codenotes
Version: 0.0.2
Summary: A simple CLI where you can save and view all your created annotations
Home-page: https://github.com/EGAMAGZ/codenotes
Author: Gamaliel Garcia
Author-email: egamagz.dev@outlook.com
License: MIT
Keywords: cli cui tui curses command-line note task codenotes
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Console :: Curses
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Office/Business :: Scheduling
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: astroid (==2.4.2)
Requires-Dist: colorama (==0.4.4)
Requires-Dist: commonmark (==0.9.1)
Requires-Dist: isort (==5.6.4)
Requires-Dist: lazy-object-proxy (==1.4.3)
Requires-Dist: mccabe (==0.6.1)
Requires-Dist: py-cui (==0.1.2)
Requires-Dist: Pygments (==2.7.4)
Requires-Dist: pylint (==2.6.0)
Requires-Dist: rich (==9.10.0)
Requires-Dist: six (==1.15.0)
Requires-Dist: toml (==0.10.2)
Requires-Dist: typing-extensions (==3.7.4.3)
Requires-Dist: wcwidth (==0.2.5)
Requires-Dist: windows-curses (==2.2.0)
Requires-Dist: wrapt (==1.12.1)

# Codenotes
*All your annotations without quitting the terminal*

[![PyPI version](https://badge.fury.io/py/Codenotes.svg)](https://badge.fury.io/py/Codenotes)
![PyPI - License](https://img.shields.io/pypi/l/codenotes)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/codenotes)
![PyPI - Status](https://img.shields.io/pypi/status/codenotes)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

A simple CLI where you can save and view all your created annotations

## Installation
To install `codenotes`, it is recommended to use pip:
```
pip install codenotes
```
You can install it from source. Clone this repository and use pip to install:
```
git clone https://github.com/EGAMAGZ/codenotes.git
cd codenotes
pip install .
```

If `codenotes` is already installed and you would like to update it, use:
```
pip install --upgrade codenotes
```
If updating local version, use:
```
cd codenotes
git pull
pip install --upgrade .
```
## Usage
Run `codenotes` to display the usage text.

```
codenotes <annotation> <action> <flags>
```
<img src="images/CodenotesSample.gif">

**Features**
* Create notes and tasks, and saves them in a category optionally specified
* Create categories for the different annotations
* Check the annotations or categories that will be created with a preview
* Create categories where tasks or notes will be saved
* Search for annotations created today, yesterday, during the week, month and ever, and by keywords
* Search for categories created in each type of annotation or in all of them at the same time, and search by keywords
## Unit Tests
`codenotes` unit tests are written for `unittest`, using `tox` and `pyenv`. List of python versions tested and supported:
* 3.9
* 3.10.0b3

## License
MIT License

Copyright (c) 2021 Gamaliel Garcia


