Skip to main content

A CLI note-taking application

Project description

Colinote

Colinote is a command-line tool for managing notes.

Installation

You can install Colinote using pip:

pip install colinote

Usage

To use Colinote, simply run the colinote command followed by the action you want to perform and any relevant options.

Actions

add: Add a new note to a context.

edit: Edit an existing note.

delete: Delete an existing note.

show: List all notes or all notes for a specific id,context or date.

Options

  • -c, --context: The context for the note.
  • -t, --text: The text of the note.
  • -d, --date: The date of the note (in the format "YYYY-MM-DD").
  • -i, --id: The ID of the note.

Examples

Add a note in default context (todo)

colinote add "I did something amazing"

Add a note in context "standup"

colinote add "I did something amazing" -c "standup"

Edit a note with id 1 and change the text

colinote edit 1 -t "I did something even more amazing"

Edit a note with id 1 and change the context

colinote edit 1 -c "standup"

Delete note with id 1

colinote delete 1

List all notes

colinote show

List all notes for a specific context

colinote show -c "work"

List all notes for a specific date

colinote show -d "2023-01-01"

Show a specific note

colinote show -i 1

Contributing

Contributions are always welcome! Here are some ways to contribute:

  • Fork the repository and make changes on your local branch.
  • Create a pull request with your changes.
  • Work on open issues.

Development

To develop Colinote, first clone the repository:

git clone https://github.com/tiakas/colinote.git`
cd colinote

Then, install the development dependencies:

pip install -r requirements.txt

To run the tests, use:

pytest

To build the package, use:

python setup.py sdist bdist_wheel

This will create a dist directory containing the source distribution (.tar.gz) and wheel distribution (.whl) of the package.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

colinote-0.1.0.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

colinote-0.1.0-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file colinote-0.1.0.tar.gz.

File metadata

  • Download URL: colinote-0.1.0.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for colinote-0.1.0.tar.gz
Algorithm Hash digest
SHA256 116a37dd9e80899fef6e6fd9ec3f4435988da77bdd6d75b12ae8e1c0b7e3fce8
MD5 95b22a8559864df3740ef4923cfd7525
BLAKE2b-256 2030e0d5a37d4b856d80e18147a5c02d0eccce577f7ff519553ceb08db16541b

See more details on using hashes here.

File details

Details for the file colinote-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: colinote-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for colinote-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 96dfbd5ad18c9cb4073d048240aedeabf65bdbe10d3dff764ae2227b44446ccc
MD5 6f505d8a52c265aa62469957dad3514e
BLAKE2b-256 a06c6fe4eb7332756bf8335e4f254907c712341e4cc32a3d7844e2b3dce8757d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page