# kanbanpy
A console-based Kanban task manager created in Python.
Create and manage tasks visually in your terminal using simple commands.
## Features
- Simple CLI commands
- ASCII based kanban board
- Easy setup
- Stores tasks in a readable format (JSON).
## Installation
Install using pip running the following command in the terminal:
```sh
pip install kanbanpy
```
## Configuration
kanbanpy requires a config file located in the user's home directory. This file
can be generated using the `setup` command:
```sh
# Run the setup wizard
kanbanpy setup
# Or use the defaults
kanbanpy setup -y
```
## Usage
If you installed the library, you can use the CLI as a system command:
```sh
kanbanpy [...args]
```
Or call it as a Python import:
```sh
python -m kanbanpy [...args]
```
### Examples
Here are some examples of the commands available:
```sh
# Just display the kanban board
kanbanpy
# Create a new task
kanbanpy create "A new todo"
# Move task with id 1 to the next status
kanbanpy next 1
# Revert a task with id 1 to the previous status
kanbanpy prev 1
# Remove task with id 1
kanbanpy remove 1
```
Commands also have convenient aliases:
- `create`: `c`
- `next`: `n`
- `prev`: `p`
- `remove`: `r`
To explore the full list of commands, run:
```sh
kanbanpy --help
```
### Tips
#### Aliases
A handful technique is to define a shell alias to call the cli and take
advantage of the command aliases defined by the package.
```sh
# Instead of running:
kanbanpy create "my new todo"
# Define an alias in your .bashrc or .zshrc:
alias kb="kanbanpy"
# And type shorter commands:
kb c "my new todo"
```
#### Important tasks
Include a '!' in a task todo to mark it as important. The task will be
highlighted when displaying the board:
```sh
kanbanpy create "an important todo!"
kanbanpy create "project!: todo title"
kanbanpy create "(!) new todo"
```
## Contributing
Thank you for considering contributing to my project! Any pull requests are
welcome and greatly appreciated. If you encounter any issues while using
the project, please feel free to post them on the issue tracker.
To contribute to the project, please follow these steps:
1. Fork the repository.
2. Add a new feature or bug fix.
3. Commit them using descriptive messages, using
[conventional commits](https://www.conventionalcommits.org/) is recommended.
4. Submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/OscarM3615/kanbanpy",
"name": "kanbanpy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "kanban,project,management",
"author": "\u00d3scar Miranda",
"author_email": "oscarmiranda3615@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f6/ff/aaf222bd71e1f5ac3025331d001b318dcb8510bfd9cdd35de5291caa0a08/kanbanpy-1.2.0.tar.gz",
"platform": null,
"description": "# kanbanpy\n\nA console-based Kanban task manager created in Python.\n\nCreate and manage tasks visually in your terminal using simple commands.\n\n## Features\n\n- Simple CLI commands\n- ASCII based kanban board\n- Easy setup\n- Stores tasks in a readable format (JSON).\n\n## Installation\n\nInstall using pip running the following command in the terminal:\n\n```sh\npip install kanbanpy\n```\n\n## Configuration\n\nkanbanpy requires a config file located in the user's home directory. This file\ncan be generated using the `setup` command:\n\n```sh\n# Run the setup wizard\nkanbanpy setup\n\n# Or use the defaults\nkanbanpy setup -y\n```\n\n## Usage\n\nIf you installed the library, you can use the CLI as a system command:\n\n```sh\nkanbanpy [...args]\n```\n\nOr call it as a Python import:\n\n```sh\npython -m kanbanpy [...args]\n```\n\n### Examples\n\nHere are some examples of the commands available:\n\n```sh\n# Just display the kanban board\nkanbanpy\n\n# Create a new task\nkanbanpy create \"A new todo\"\n\n# Move task with id 1 to the next status\nkanbanpy next 1\n\n# Revert a task with id 1 to the previous status\nkanbanpy prev 1\n\n# Remove task with id 1\nkanbanpy remove 1\n```\n\nCommands also have convenient aliases:\n\n- `create`: `c`\n- `next`: `n`\n- `prev`: `p`\n- `remove`: `r`\n\nTo explore the full list of commands, run:\n\n```sh\nkanbanpy --help\n```\n\n### Tips\n\n#### Aliases\n\nA handful technique is to define a shell alias to call the cli and take\nadvantage of the command aliases defined by the package.\n\n```sh\n# Instead of running:\nkanbanpy create \"my new todo\"\n\n# Define an alias in your .bashrc or .zshrc:\nalias kb=\"kanbanpy\"\n\n# And type shorter commands:\nkb c \"my new todo\"\n```\n\n#### Important tasks\n\nInclude a '!' in a task todo to mark it as important. The task will be\nhighlighted when displaying the board:\n\n```sh\nkanbanpy create \"an important todo!\"\n\nkanbanpy create \"project!: todo title\"\n\nkanbanpy create \"(!) new todo\"\n```\n\n## Contributing\n\nThank you for considering contributing to my project! Any pull requests are\nwelcome and greatly appreciated. If you encounter any issues while using\nthe project, please feel free to post them on the issue tracker.\n\nTo contribute to the project, please follow these steps:\n\n1. Fork the repository.\n2. Add a new feature or bug fix.\n3. Commit them using descriptive messages, using\n [conventional commits](https://www.conventionalcommits.org/) is recommended.\n4. Submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file\nfor more details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A console-based Kanban task manager created in Python.",
"version": "1.2.0",
"split_keywords": [
"kanban",
"project",
"management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bcaa861a428e974c2a7c15fdcdef0f010e4529c10be21c2d7e64d6facab12e34",
"md5": "1c7424554cf228cb410f17cb528b8444",
"sha256": "465956facbea64cf03b8969bd1b0ff2dd8296510d629ae012d669fb63d5481dd"
},
"downloads": -1,
"filename": "kanbanpy-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c7424554cf228cb410f17cb528b8444",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 11347,
"upload_time": "2023-04-05T21:08:26",
"upload_time_iso_8601": "2023-04-05T21:08:26.707588Z",
"url": "https://files.pythonhosted.org/packages/bc/aa/861a428e974c2a7c15fdcdef0f010e4529c10be21c2d7e64d6facab12e34/kanbanpy-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f6ffaaf222bd71e1f5ac3025331d001b318dcb8510bfd9cdd35de5291caa0a08",
"md5": "f6127488cd1ae781618f255e64d32608",
"sha256": "3eb62a736888941817017c59e4bbc2a948a5a83290f2346a22423c3c482d4037"
},
"downloads": -1,
"filename": "kanbanpy-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "f6127488cd1ae781618f255e64d32608",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7450,
"upload_time": "2023-04-05T21:08:28",
"upload_time_iso_8601": "2023-04-05T21:08:28.231735Z",
"url": "https://files.pythonhosted.org/packages/f6/ff/aaf222bd71e1f5ac3025331d001b318dcb8510bfd9cdd35de5291caa0a08/kanbanpy-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-05 21:08:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "OscarM3615",
"github_project": "kanbanpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "kanbanpy"
}
JSON
