# TaskMan CLI
## 📝 Description
TaskMan CLI is a powerful and user-friendly task management application built with Python. It offers a seamless command-line interface for efficiently managing your daily tasks, helping you boost productivity and stay organized.
**Important Note: This project is for learning purposes and is based on the original script by me. The original repository can be found at [TaskMan CLI](https://github.com/tahadnan/TaskMan-CLI.git) repo.**
## ✨ Features
- 📌 **Add Tasks**: Easily add new tasks to your to-do list
- 🗑️ **Remove Tasks**: Remove tasks from your to-do list
- ✅ **Mark Tasks as Completed**: Move tasks to a "done" list when completed
- 👀 **View Current State**: See all your tasks, both pending and completed
- 🧹 **Clear Lists**: Clean up your to-do and done lists with a single command
- 💾 **Data Persistence**: Your tasks are saved automatically, so you never lose your progress
- 📊 **Generate Reports**: Create daily task reports to track your productivity
## 🚀 Installation
You can install TaskMan CLI using pip:
```bash
pip install taskman-cli
```
## 🛠️ Usage
After installation, you can start TaskMan CLI by running:
```bash
taskman
```
Once launched, you'll see the TaskMan welcome screen. Type `help` to see available commands:
```
TaskMan > help
```
Use the various commands to manage your tasks. Here are some examples:
```
TaskMan > add Buy groceries | Call mom | Finish report
TaskMan > list-todo
TaskMan > mark-as-done Buy groceries
TaskMan > list-both
```
## 📚 Available Commands
- `add [task1] | [task2] | ...`: Add one or more tasks
- `remove [task1] | [task2] | ...`: Remove one or more tasks
- `mark-as-done / mad [task1]...`: Mark one or more tasks as completed
- `list-both / lb`: Show all tasks (to-do and done)
- `list-todo / ltd`: Show pending tasks
- `list-done / ld`: Show completed tasks
- `clear-todo / cltd`: Clear all pending tasks
- `clear-done / cld`: Clear all completed tasks
- `reset`: Clear all tasks (both to-do and done)
- `report [name]`: Generate a report (optional custom name)
- `save`: Save current state to file
- `help`: Show the help message
- `clear / Ctrl+l`: Clear the screen
- `exit`: Exit the program
## 💡 Tips
- Use the up and down arrow keys to navigate through your command history.
- TaskMan supports auto-completion. Start typing a command and press Tab to complete it.
- Your tasks can be saved, so you can safely exit with saving the current state and resume your work later.
## 🤝 Contributing
Contributions are welcome! Here's how you can contribute:
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
Please make sure to update tests as appropriate.
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- Inspired by the ZTM Python course by Andrei Neagoie
- Built with love using Python and prompt_toolkit
## 📞 Contact
If you have any questions, feel free to reach out:
- Gmail - taha.y.adnan@gmail.com
- Project Link: [TaskMan-CLI-PyPi](https://github.com/tahadnan/TaskMan-CLI-PyPi.git)
---
<div align="center">
Made with ❤️ by [Taha Yasser Adnan](https://github.com/tahadnan)
</div>
Raw data
{
"_id": null,
"home_page": "https://github.com/tahadnan/TaskMan-CLI-PyPI",
"name": "taskman-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Taha Yasser Adnan",
"author_email": "taha.y.adnan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c8/7d/71a4dbb934f640c5721cad80a7422e4224b62d1d42da4fb3c75c36636896/taskman_cli-0.4.2.tar.gz",
"platform": null,
"description": "# TaskMan CLI\n## \ud83d\udcdd Description\n\nTaskMan CLI is a powerful and user-friendly task management application built with Python. It offers a seamless command-line interface for efficiently managing your daily tasks, helping you boost productivity and stay organized. \n**Important Note: This project is for learning purposes and is based on the original script by me. The original repository can be found at [TaskMan CLI](https://github.com/tahadnan/TaskMan-CLI.git) repo.**\n\n## \u2728 Features\n\n- \ud83d\udccc **Add Tasks**: Easily add new tasks to your to-do list\n- \ud83d\uddd1\ufe0f **Remove Tasks**: Remove tasks from your to-do list\n- \u2705 **Mark Tasks as Completed**: Move tasks to a \"done\" list when completed\n- \ud83d\udc40 **View Current State**: See all your tasks, both pending and completed\n- \ud83e\uddf9 **Clear Lists**: Clean up your to-do and done lists with a single command\n- \ud83d\udcbe **Data Persistence**: Your tasks are saved automatically, so you never lose your progress\n- \ud83d\udcca **Generate Reports**: Create daily task reports to track your productivity\n\n## \ud83d\ude80 Installation\n\nYou can install TaskMan CLI using pip:\n\n```bash\npip install taskman-cli\n```\n\n## \ud83d\udee0\ufe0f Usage\n\nAfter installation, you can start TaskMan CLI by running:\n\n```bash\ntaskman\n```\n\nOnce launched, you'll see the TaskMan welcome screen. Type `help` to see available commands:\n\n```\nTaskMan > help\n```\n\nUse the various commands to manage your tasks. Here are some examples:\n\n```\nTaskMan > add Buy groceries | Call mom | Finish report\nTaskMan > list-todo\nTaskMan > mark-as-done Buy groceries\nTaskMan > list-both\n```\n\n## \ud83d\udcda Available Commands\n\n- `add [task1] | [task2] | ...`: Add one or more tasks\n- `remove [task1] | [task2] | ...`: Remove one or more tasks\n- `mark-as-done / mad [task1]...`: Mark one or more tasks as completed\n- `list-both / lb`: Show all tasks (to-do and done)\n- `list-todo / ltd`: Show pending tasks\n- `list-done / ld`: Show completed tasks\n- `clear-todo / cltd`: Clear all pending tasks\n- `clear-done / cld`: Clear all completed tasks\n- `reset`: Clear all tasks (both to-do and done)\n- `report [name]`: Generate a report (optional custom name)\n- `save`: Save current state to file\n- `help`: Show the help message\n- `clear / Ctrl+l`: Clear the screen\n- `exit`: Exit the program\n\n## \ud83d\udca1 Tips\n\n- Use the up and down arrow keys to navigate through your command history.\n- TaskMan supports auto-completion. Start typing a command and press Tab to complete it.\n- Your tasks can be saved, so you can safely exit with saving the current state and resume your work later.\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Here's how you can contribute:\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\nPlease make sure to update tests as appropriate.\n\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## \ud83d\ude4f Acknowledgments\n\n- Inspired by the ZTM Python course by Andrei Neagoie\n- Built with love using Python and prompt_toolkit\n\n## \ud83d\udcde Contact\n\nIf you have any questions, feel free to reach out:\n\n- Gmail - taha.y.adnan@gmail.com\n- Project Link: [TaskMan-CLI-PyPi](https://github.com/tahadnan/TaskMan-CLI-PyPi.git)\n\n---\n\n<div align=\"center\">\n\nMade with \u2764\ufe0f by [Taha Yasser Adnan](https://github.com/tahadnan)\n\n</div>\n",
"bugtrack_url": null,
"license": null,
"summary": "A minimalistic and user-friendly task management application built with Python",
"version": "0.4.2",
"project_urls": {
"Bug Tracker": "https://github.com/tahadnan/TaskMan-CLI-PyPI/issues",
"Homepage": "https://github.com/tahadnan/TaskMan-CLI-PyPI"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d82f83798cbec74020959488ab3ffddf1eac6d99cd6b7ccdc06165124e64f3a2",
"md5": "81d9d1b69eda67add888879452260146",
"sha256": "1e5c199aa937290a3cf0140476963665bfeda283dfe1fcf3e68ed437df3579d5"
},
"downloads": -1,
"filename": "taskman_cli-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81d9d1b69eda67add888879452260146",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6856,
"upload_time": "2024-10-20T10:15:09",
"upload_time_iso_8601": "2024-10-20T10:15:09.026078Z",
"url": "https://files.pythonhosted.org/packages/d8/2f/83798cbec74020959488ab3ffddf1eac6d99cd6b7ccdc06165124e64f3a2/taskman_cli-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c87d71a4dbb934f640c5721cad80a7422e4224b62d1d42da4fb3c75c36636896",
"md5": "0f9601dc4a93b3e46c6b70b93a88a73a",
"sha256": "e3b6fb194820eef7b82c96f018d8f6d57726429bf646288b3abc39d7480e1fb2"
},
"downloads": -1,
"filename": "taskman_cli-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "0f9601dc4a93b3e46c6b70b93a88a73a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6576,
"upload_time": "2024-10-20T10:15:10",
"upload_time_iso_8601": "2024-10-20T10:15:10.871417Z",
"url": "https://files.pythonhosted.org/packages/c8/7d/71a4dbb934f640c5721cad80a7422e4224b62d1d42da4fb3c75c36636896/taskman_cli-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 10:15:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tahadnan",
"github_project": "TaskMan-CLI-PyPI",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "taskman-cli"
}
JSON
