| Name | todoforge JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-11-09 09:12:20 |
| maintainer | None |
| docs_url | None |
| author | Hemanth |
| requires_python | <4.0,>=3.12 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `Todoforge`
Todoforge is a fast, custom-built CLI-based to-do tracker designed for productive developers. Organize tasks seamlessly by creating dedicated spaces (like work, personal, or project-specific), making task management more efficient and focused. Simple, intuitive, and lightweight, Todoforge enables you to boost productivity without the clutter of complex tools.
---
**Usage**:
```console
$ tdf [OPTIONS] COMMAND [ARGS]...
```
_NOTE: todoforge uses `tdf` alias for concise and better typing experience_
**Options**:
- `--install-completion`: Install completion for the current shell.
- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
- `--help`: Show this message and exit.
**Commands**:
- `add`: Add task to todos list.
- `done`: Mark todo as done.
- `edit`: Edit todo title.
- `ls`: Show todos in current space.
- `remove`: Remove a task from the todo list.
- `spaces`: Manage spaces
- `toggle`: Toggle Task in an interactive window.
- `undo`: Mark todo as undone.
## `tdf add`
Add task to todos list.
**Usage**:
```console
$ tdf add [OPTIONS] TITLE
```
**Arguments**:
- `TITLE`: [required]
**Options**:
- `--done / --not-done`: Is the todo completed? [default: not-done]
- `--help`: Show this message and exit.
## `tdf done`
Mark todo as done.
**Usage**:
```console
$ tdf done [OPTIONS] todo-id
```
**Arguments**:
- `todo-id`: Todo id. Supports both partial and full id [required]
**Options**:
- `--help`: Show this message and exit.
## `tdf edit`
Edit todo title.
**Usage**:
```console
$ tdf edit [OPTIONS] todo-id
```
**Arguments**:
- `todo-id`: Todo id. Supports both partial and full id [required]
**Options**:
- `--help`: Show this message and exit.
## `tdf ls`
Show todos in current space.
**Usage**:
```console
$ tdf ls [OPTIONS]
```
**Options**:
- `-f, --full-id / --not-full-id`: Show full id for the todo [default: not-full-id]
- `--help`: Show this message and exit.
## `tdf remove`
Remove a task from the todo list.
**Usage**:
```console
$ tdf remove [OPTIONS] todo-id
```
**Arguments**:
- `todo-id`: Todo id. Supports both partial and full id [required]
**Options**:
- `--help`: Show this message and exit.
## `tdf spaces`
Manage spaces
**Usage**:
```console
$ tdf spaces [OPTIONS] COMMAND [ARGS]...
```
**Options**:
- `--help`: Show this message and exit.
**Commands**:
- `add`: Creates a new space for organizing todos.
- `ls`: Lists all available spaces.
- `remove`: Removes a space.
- `rename`: Renames an existing space.
- `switch`: Switch between spaces.
### `tdf spaces add`
Creates a new space for organizing todos.
This command allows the user to create a new space when related todos can be stored.
A Space can be a specific context like 'personal' or 'work' to help categorize tasks.
Args:
space_name (str): Name of the space you want to create
Returns:
None: Prints if the space is created successfully or not
Example:
$ todoforge spaces add personal
**Usage**:
```console
$ tdf spaces add [OPTIONS] SPACE_NAME
```
**Arguments**:
- `SPACE_NAME`: [required]
**Options**:
- `--help`: Show this message and exit.
### `tdf spaces ls`
Lists all available spaces.
This command displays the names of all the spaces created by the user.
Returns:
None: Confirms the list of available spaces with asterisk (\*) that let's the user know about the current working space.
Example:
$ todoforge ls \* personal
work
**Usage**:
```console
$ tdf spaces ls [OPTIONS]
```
**Options**:
- `--help`: Show this message and exit.
### `tdf spaces remove`
Removes a space.
Deletes the specified space and its associated todos.
Args:
space_name (str): The name of the space to remove.
Returns:
None: Confirms the removal of the specified space.
Example:
$ todoforge remove personal
Space 'personal' has been removed.
**Usage**:
```console
$ tdf spaces remove [OPTIONS] SPACE_NAME
```
**Arguments**:
- `SPACE_NAME`: [required]
**Options**:
- `--help`: Show this message and exit.
### `tdf spaces rename`
Renames an existing space.
Changes the name of a specified space to a new one.
Args:
old_name (str): The current name of the space
new_name (str): The new name of the space
Returns:
None: Confirms the rename of the specified space.
Example:
$ todoforge rename personal home
Space 'personal' has been renamed to 'home'
**Usage**:
```console
$ tdf spaces rename [OPTIONS] OLD_NAME NEW_NAME
```
**Arguments**:
- `OLD_NAME`: [required]
- `NEW_NAME`: [required]
**Options**:
- `--help`: Show this message and exit.
### `tdf spaces switch`
Switch between spaces.
Allows the user to switch the current working space to another one.
Args:
space_name (str): The name of the space to switch to.
Returns:
None: Confirms the switch to the specific space.
Example:
$ todoforge switch work
Switched to work space
**Usage**:
```console
$ tdf spaces switch [OPTIONS] SPACE_NAME
```
**Arguments**:
- `SPACE_NAME`: [required]
**Options**:
- `--help`: Show this message and exit.
## `tdf toggle`
Toggle Task in an interactive window.
**Usage**:
```console
$ tdf toggle [OPTIONS]
```
**Options**:
- `--help`: Show this message and exit.
## `tdf undo`
Mark todo as undone.
**Usage**:
```console
$ tdf undo [OPTIONS] todo-id
```
**Arguments**:
- `todo-id`: Todo id. Supports both partial and full id [required]
**Options**:
- `--help`: Show this message and exit.
Raw data
{
"_id": null,
"home_page": null,
"name": "todoforge",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Hemanth",
"author_email": "hemanthhari2000@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b5/aa/377ea375e4b33e1185dc4c7319d38c32f1719358621f8d3d563d91017243/todoforge-1.0.0.tar.gz",
"platform": null,
"description": "# `Todoforge`\n\nTodoforge is a fast, custom-built CLI-based to-do tracker designed for productive developers. Organize tasks seamlessly by creating dedicated spaces (like work, personal, or project-specific), making task management more efficient and focused. Simple, intuitive, and lightweight, Todoforge enables you to boost productivity without the clutter of complex tools.\n\n---\n\n**Usage**:\n\n```console\n$ tdf [OPTIONS] COMMAND [ARGS]...\n```\n\n_NOTE: todoforge uses `tdf` alias for concise and better typing experience_\n\n**Options**:\n\n- `--install-completion`: Install completion for the current shell.\n- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n- `--help`: Show this message and exit.\n\n**Commands**:\n\n- `add`: Add task to todos list.\n- `done`: Mark todo as done.\n- `edit`: Edit todo title.\n- `ls`: Show todos in current space.\n- `remove`: Remove a task from the todo list.\n- `spaces`: Manage spaces\n- `toggle`: Toggle Task in an interactive window.\n- `undo`: Mark todo as undone.\n\n## `tdf add`\n\nAdd task to todos list.\n\n**Usage**:\n\n```console\n$ tdf add [OPTIONS] TITLE\n```\n\n**Arguments**:\n\n- `TITLE`: [required]\n\n**Options**:\n\n- `--done / --not-done`: Is the todo completed? [default: not-done]\n- `--help`: Show this message and exit.\n\n## `tdf done`\n\nMark todo as done.\n\n**Usage**:\n\n```console\n$ tdf done [OPTIONS] todo-id\n```\n\n**Arguments**:\n\n- `todo-id`: Todo id. Supports both partial and full id [required]\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n## `tdf edit`\n\nEdit todo title.\n\n**Usage**:\n\n```console\n$ tdf edit [OPTIONS] todo-id\n```\n\n**Arguments**:\n\n- `todo-id`: Todo id. Supports both partial and full id [required]\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n## `tdf ls`\n\nShow todos in current space.\n\n**Usage**:\n\n```console\n$ tdf ls [OPTIONS]\n```\n\n**Options**:\n\n- `-f, --full-id / --not-full-id`: Show full id for the todo [default: not-full-id]\n- `--help`: Show this message and exit.\n\n## `tdf remove`\n\nRemove a task from the todo list.\n\n**Usage**:\n\n```console\n$ tdf remove [OPTIONS] todo-id\n```\n\n**Arguments**:\n\n- `todo-id`: Todo id. Supports both partial and full id [required]\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n## `tdf spaces`\n\nManage spaces\n\n**Usage**:\n\n```console\n$ tdf spaces [OPTIONS] COMMAND [ARGS]...\n```\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n**Commands**:\n\n- `add`: Creates a new space for organizing todos.\n- `ls`: Lists all available spaces.\n- `remove`: Removes a space.\n- `rename`: Renames an existing space.\n- `switch`: Switch between spaces.\n\n### `tdf spaces add`\n\nCreates a new space for organizing todos.\n\nThis command allows the user to create a new space when related todos can be stored.\nA Space can be a specific context like 'personal' or 'work' to help categorize tasks.\n\nArgs:\nspace_name (str): Name of the space you want to create\n\nReturns:\nNone: Prints if the space is created successfully or not\n\nExample:\n$ todoforge spaces add personal\n\n**Usage**:\n\n```console\n$ tdf spaces add [OPTIONS] SPACE_NAME\n```\n\n**Arguments**:\n\n- `SPACE_NAME`: [required]\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n### `tdf spaces ls`\n\nLists all available spaces.\n\nThis command displays the names of all the spaces created by the user.\n\nReturns:\nNone: Confirms the list of available spaces with asterisk (\\*) that let's the user know about the current working space.\n\nExample:\n$ todoforge ls \\* personal\nwork\n\n**Usage**:\n\n```console\n$ tdf spaces ls [OPTIONS]\n```\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n### `tdf spaces remove`\n\nRemoves a space.\n\nDeletes the specified space and its associated todos.\n\nArgs:\nspace_name (str): The name of the space to remove.\n\nReturns:\nNone: Confirms the removal of the specified space.\n\nExample:\n$ todoforge remove personal\nSpace 'personal' has been removed.\n\n**Usage**:\n\n```console\n$ tdf spaces remove [OPTIONS] SPACE_NAME\n```\n\n**Arguments**:\n\n- `SPACE_NAME`: [required]\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n### `tdf spaces rename`\n\nRenames an existing space.\n\nChanges the name of a specified space to a new one.\n\nArgs:\nold_name (str): The current name of the space\nnew_name (str): The new name of the space\n\nReturns:\nNone: Confirms the rename of the specified space.\n\nExample:\n$ todoforge rename personal home\nSpace 'personal' has been renamed to 'home'\n\n**Usage**:\n\n```console\n$ tdf spaces rename [OPTIONS] OLD_NAME NEW_NAME\n```\n\n**Arguments**:\n\n- `OLD_NAME`: [required]\n- `NEW_NAME`: [required]\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n### `tdf spaces switch`\n\nSwitch between spaces.\n\nAllows the user to switch the current working space to another one.\n\nArgs:\nspace_name (str): The name of the space to switch to.\n\nReturns:\nNone: Confirms the switch to the specific space.\n\nExample:\n$ todoforge switch work\nSwitched to work space\n\n**Usage**:\n\n```console\n$ tdf spaces switch [OPTIONS] SPACE_NAME\n```\n\n**Arguments**:\n\n- `SPACE_NAME`: [required]\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n## `tdf toggle`\n\nToggle Task in an interactive window.\n\n**Usage**:\n\n```console\n$ tdf toggle [OPTIONS]\n```\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n## `tdf undo`\n\nMark todo as undone.\n\n**Usage**:\n\n```console\n$ tdf undo [OPTIONS] todo-id\n```\n\n**Arguments**:\n\n- `todo-id`: Todo id. Supports both partial and full id [required]\n\n**Options**:\n\n- `--help`: Show this message and exit.\n\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "1.0.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "08cbfd1a902e2ba6b4b2240b461c3ee8ecf99b7b08693e3838f277758c13f015",
"md5": "02ffd99417f150f1dcc8636c5a75f792",
"sha256": "b1bb931dd81d764dd96a871b885900c133423cb25c5a1519e48782070f347fc0"
},
"downloads": -1,
"filename": "todoforge-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "02ffd99417f150f1dcc8636c5a75f792",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 10888,
"upload_time": "2024-11-09T09:12:19",
"upload_time_iso_8601": "2024-11-09T09:12:19.055933Z",
"url": "https://files.pythonhosted.org/packages/08/cb/fd1a902e2ba6b4b2240b461c3ee8ecf99b7b08693e3838f277758c13f015/todoforge-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5aa377ea375e4b33e1185dc4c7319d38c32f1719358621f8d3d563d91017243",
"md5": "e254790e85da03fe76dbe18b0251d5d2",
"sha256": "df0878a393b8b65168d7fe0814e27ce3e2496fca6b0d775bff305dfc071b2876"
},
"downloads": -1,
"filename": "todoforge-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e254790e85da03fe76dbe18b0251d5d2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 8924,
"upload_time": "2024-11-09T09:12:20",
"upload_time_iso_8601": "2024-11-09T09:12:20.814095Z",
"url": "https://files.pythonhosted.org/packages/b5/aa/377ea375e4b33e1185dc4c7319d38c32f1719358621f8d3d563d91017243/todoforge-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-09 09:12:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "todoforge"
}
