Metadata-Version: 2.1
Name: Codenotes
Version: 0.0.1
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
Description: # Codenotes
        *All your annotations without quitting the terminal*
        
        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 <action> <annotation> <flags>
        ```
        <img src="images/CodenotesSample.gif">
        
        **Features**
        * Creates notes and tasks, and saves them in a category optionally specified
        * Shows a preview of the annotation creation
        * Creates categories where tasks or notes will be saved
        * Searches for annotations created today, yesterday, during the week or month
        
        ## Unit Tests
        `codenotes` unit tests are written for `unittest`. To run the tests:
        ```
        python -m unittest
        ```
        
        ## License
        MIT License
        
        Copyright (c) 2021 Gamaliel Garcia
        
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
