# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/tiakas/colinote",
"name": "colinote",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "cli,note-taking",
"author": "Giannis Tiakas",
"author_email": "giannis@tiakas.com",
"download_url": "https://files.pythonhosted.org/packages/20/30/e0d5a37d4b856d80e18147a5c02d0eccce577f7ff519553ceb08db16541b/colinote-0.1.0.tar.gz",
"platform": null,
"description": "# Colinote\n\nColinote is a command-line tool for managing notes.\n\n## Installation\n\nYou can install Colinote using pip:\n\n```\npip install colinote\n```\n\n\n## Usage\n\nTo use Colinote, simply run the colinote command followed by the action you want to perform and any relevant options.\n\n## Actions\n*add:* Add a new note to a context.\n\n*edit:* Edit an existing note.\n\n*delete:* Delete an existing note.\n\n*show*: List all notes or all notes for a specific id,context or date.\n\n*Options*\n- *-c, --context:* The context for the note.\n- *-t, --text:* The text of the note.\n- *-d, --date:* The date of the note (in the format \"YYYY-MM-DD\").\n- *-i, --id:* The ID of the note.\n\n### Examples\n\n*Add a note in default context (todo)*\n```\ncolinote add \"I did something amazing\"\n```\n\n*Add a note in context \"standup\"*\n```\ncolinote add \"I did something amazing\" -c \"standup\"\n```\n\n*Edit a note with id 1 and change the text*\n```\ncolinote edit 1 -t \"I did something even more amazing\"\n```\n\n*Edit a note with id 1 and change the context*\n```\ncolinote edit 1 -c \"standup\"\n```\n\n*Delete note with id 1*\n```\ncolinote delete 1\n```\n\n*List all notes*\n```\ncolinote show\n```\n\n*List all notes for a specific context*\n```\ncolinote show -c \"work\"\n```\n\n*List all notes for a specific date*\n```\ncolinote show -d \"2023-01-01\"\n```\n\n*Show a specific note*\n```\ncolinote show -i 1\n```\n\n## Contributing\nContributions are always welcome! Here are some ways to contribute:\n\n- Fork the repository and make changes on your local branch.\n- Create a pull request with your changes.\n- Work on open issues.\n\n## Development\n\nTo develop Colinote, first clone the repository:\n```\ngit clone https://github.com/tiakas/colinote.git`\ncd colinote\n```\nThen, install the development dependencies:\n\n```\npip install -r requirements.txt\n```\n\nTo run the tests, use:\n```\npytest\n```\n\nTo build the package, use:\n```\npython setup.py sdist bdist_wheel\n```\n\nThis will create a dist directory containing the source distribution (*.tar.gz) and wheel distribution (*.whl) of the package.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n",
"bugtrack_url": null,
"license": "",
"summary": "A CLI note-taking application",
"version": "0.1.0",
"split_keywords": [
"cli",
"note-taking"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a06c6fe4eb7332756bf8335e4f254907c712341e4cc32a3d7844e2b3dce8757d",
"md5": "6f505d8a52c265aa62469957dad3514e",
"sha256": "96dfbd5ad18c9cb4073d048240aedeabf65bdbe10d3dff764ae2227b44446ccc"
},
"downloads": -1,
"filename": "colinote-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f505d8a52c265aa62469957dad3514e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7644,
"upload_time": "2023-04-26T22:26:53",
"upload_time_iso_8601": "2023-04-26T22:26:53.937267Z",
"url": "https://files.pythonhosted.org/packages/a0/6c/6fe4eb7332756bf8335e4f254907c712341e4cc32a3d7844e2b3dce8757d/colinote-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2030e0d5a37d4b856d80e18147a5c02d0eccce577f7ff519553ceb08db16541b",
"md5": "95b22a8559864df3740ef4923cfd7525",
"sha256": "116a37dd9e80899fef6e6fd9ec3f4435988da77bdd6d75b12ae8e1c0b7e3fce8"
},
"downloads": -1,
"filename": "colinote-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "95b22a8559864df3740ef4923cfd7525",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6422,
"upload_time": "2023-04-26T22:26:56",
"upload_time_iso_8601": "2023-04-26T22:26:56.175664Z",
"url": "https://files.pythonhosted.org/packages/20/30/e0d5a37d4b856d80e18147a5c02d0eccce577f7ff519553ceb08db16541b/colinote-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-26 22:26:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "tiakas",
"github_project": "colinote",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": []
},
{
"name": "rich",
"specs": []
},
{
"name": "pytest",
"specs": []
}
],
"lcname": "colinote"
}
JSON
