# nag 🐍️
[](https://pypi.org/project/nag/)
[](https://pepy.tech/project/nag)
**nag** is a command-line time-blocking tool designed to help you organize your day with time blocks. Add tasks to your schedule, annotate them, and display your timeline — all from the terminal.
## Features
- Add time blocks for specific tasks.
- Annotate existing time blocks.
- Display your timeline for a given day.
- Simple and intuitive command-line interface.
## Installation
#### 1. Using pipx (recommended)
pipx is a great tool for installing Python applications in isolated environments, so you don’t clutter your global Python installation.
To install pipx:
```bash
python3 -m pip install --user pipx
python3 -m pipx ensurepath
```
After you have pipx installed, you can install nag:
```bash
pipx install nag
```
This will install nag and ensure it’s available globally on your system.
#### 2. Using pip
You can also install nag using pip if you prefer to install it directly into your Python environment.
```bash
pip install nag
```
## Usage
#### 1. Adding a Time Block
To add a new task to your schedule:
```bash
nag block 09:00 10:00 "Meeting with team"
```
This will add a task from 9:00 AM to 10:00 AM with the description "Meeting with team" for today by default. You can also specify a date:
```bash
nag block 09:00 10:00 "Meeting with team" --task-date 09/19
```
#### 2. Showing your schedule
To view your schedule for today:
```bash
nag show
```
You can also show the schedule for a specific date:
```bash
nag show --date 09/19
```
#### 3. Annotating a task
To annotate an existing task using its ID (as shown in the timeline):
```bash
nag annotate <task_id> "Discussed project progress."
```
#### 4. Mark task as DONE
To mark a task as DONE:
```bash
nag done <task_id>
```
#### 5. Delete task
To delete a task using its ID:
```bash
nag delete <task_id>
```
#### Help
You can get help for any command by running:
```bash
nag --help
```
```
Usage: nag [OPTIONS] COMMAND [ARGS]...
nag 🐍️ - Command-line time-blocking tool.
Options:
--help Show this message and exit.
Commands:
annotate Annotate an existing time block using its ID.
block Add a time block to your schedule with an optional date.
delete Delete a time block using its ID.
done Mark a time block as done using its ID.
show Show the timeline for the given date.
```
For specific commands, you can also run:
```
nag block --help
nag show --help
nag annotate --help
nag done --help
nag delete --help
```
## Contributing
Contributions are welcome! If you’d like to contribute to this project, feel free to open a pull request or submit an issue.
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://github.com/ykumards/nag",
"name": "nag",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "productivity, time management, nag, CLI, time blocker",
"author": "Yogesh Kumar",
"author_email": "ykumards@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ee/d1/36df8828bd5e4dd21aab57680351689c901eaf9953d62b6182b74e532f95/nag-0.3.0b1.tar.gz",
"platform": null,
"description": "# nag \ud83d\udc0d\ufe0f\n\n\n\n[](https://pypi.org/project/nag/)\n[](https://pepy.tech/project/nag)\n\n\n**nag** is a command-line time-blocking tool designed to help you organize your day with time blocks. Add tasks to your schedule, annotate them, and display your timeline \u2014 all from the terminal.\n\n## Features\n\n- Add time blocks for specific tasks.\n- Annotate existing time blocks.\n- Display your timeline for a given day.\n- Simple and intuitive command-line interface.\n\n## Installation\n\n#### 1. Using pipx (recommended)\n\npipx is a great tool for installing Python applications in isolated environments, so you don\u2019t clutter your global Python installation.\n\nTo install pipx:\n```bash\npython3 -m pip install --user pipx\npython3 -m pipx ensurepath\n```\n\nAfter you have pipx installed, you can install nag:\n\n```bash\npipx install nag\n```\n\nThis will install nag and ensure it\u2019s available globally on your system.\n\n#### 2. Using pip\n\nYou can also install nag using pip if you prefer to install it directly into your Python environment.\n\n```bash\npip install nag\n```\n\n## Usage\n\n#### 1. Adding a Time Block\n\nTo add a new task to your schedule:\n\n```bash\nnag block 09:00 10:00 \"Meeting with team\"\n```\n\nThis will add a task from 9:00 AM to 10:00 AM with the description \"Meeting with team\" for today by default. You can also specify a date:\n\n```bash\nnag block 09:00 10:00 \"Meeting with team\" --task-date 09/19\n```\n\n#### 2. Showing your schedule\n\nTo view your schedule for today:\n\n```bash\nnag show\n```\n\nYou can also show the schedule for a specific date:\n\n```bash\nnag show --date 09/19\n```\n\n#### 3. Annotating a task\n\nTo annotate an existing task using its ID (as shown in the timeline):\n\n```bash\nnag annotate <task_id> \"Discussed project progress.\"\n```\n\n#### 4. Mark task as DONE\n\nTo mark a task as DONE:\n\n```bash\nnag done <task_id>\n```\n\n#### 5. Delete task\n\nTo delete a task using its ID:\n\n```bash\nnag delete <task_id>\n```\n\n#### Help\n\nYou can get help for any command by running:\n\n```bash\nnag --help\n```\n\n```\nUsage: nag [OPTIONS] COMMAND [ARGS]...\n\n nag \ud83d\udc0d\ufe0f - Command-line time-blocking tool.\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n annotate Annotate an existing time block using its ID.\n block Add a time block to your schedule with an optional date.\n delete Delete a time block using its ID.\n done Mark a time block as done using its ID.\n show Show the timeline for the given date.\n```\n\nFor specific commands, you can also run:\n\n```\nnag block --help\nnag show --help\nnag annotate --help\nnag done --help\nnag delete --help\n```\n\n## Contributing\n\nContributions are welcome! If you\u2019d like to contribute to this project, feel free to open a pull request or submit an issue.\n\n## License\nThis project is licensed under the MIT License.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command line time blocker that nags you to get things done",
"version": "0.3.0b1",
"project_urls": {
"Homepage": "https://github.com/ykumards/nag",
"Repository": "https://github.com/ykumards/nag"
},
"split_keywords": [
"productivity",
" time management",
" nag",
" cli",
" time blocker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5924dc064563910f4382a345d6d2ea116d0f737934ed2162b8d100916133309b",
"md5": "82e11b79f9bef9b78ff920dfc07b3fce",
"sha256": "f5108bfb50e644a0f33488dacfd7cae7b17210f1e4fad9cce668d3a99ce076bf"
},
"downloads": -1,
"filename": "nag-0.3.0b1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "82e11b79f9bef9b78ff920dfc07b3fce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 7439,
"upload_time": "2024-09-19T11:19:59",
"upload_time_iso_8601": "2024-09-19T11:19:59.003444Z",
"url": "https://files.pythonhosted.org/packages/59/24/dc064563910f4382a345d6d2ea116d0f737934ed2162b8d100916133309b/nag-0.3.0b1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eed136df8828bd5e4dd21aab57680351689c901eaf9953d62b6182b74e532f95",
"md5": "7a26fb75a40cf433799a65ea421fda05",
"sha256": "62dbd78f8228bb14b4f4c8900426cc92e3ffba9a2531b55efdd9e1f467ef4543"
},
"downloads": -1,
"filename": "nag-0.3.0b1.tar.gz",
"has_sig": false,
"md5_digest": "7a26fb75a40cf433799a65ea421fda05",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 5892,
"upload_time": "2024-09-19T11:20:00",
"upload_time_iso_8601": "2024-09-19T11:20:00.027202Z",
"url": "https://files.pythonhosted.org/packages/ee/d1/36df8828bd5e4dd21aab57680351689c901eaf9953d62b6182b74e532f95/nag-0.3.0b1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-19 11:20:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ykumards",
"github_project": "nag",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nag"
}
JSON
