https://github.com/egamagz/codenotes

A simple CLI where you can save and view all your created annotations 📒
https://github.com/egamagz/codenotes

codenotes command-line console-app python terminal-app terminal-based

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/egamagz/codenotes
• Owner: EGAMAGZ
• License: mit
• Created: 2020-08-03T19:34:20.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2025-01-13T20:00:07.000Z (over 1 year ago)
• Last Synced: 2025-04-05T16:41:27.005Z (about 1 year ago)
• Topics: codenotes, command-line, console-app, python, terminal-app, terminal-based
• Language: Python
• Homepage:
• Size: 848 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

          
# 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   

```



**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