Skip to main content

A CLI tool for managing tasks with priorities and statuses.

Project description

📋 Priority Manager

Priority Manager is a Command-Line Interface (CLI) tool for managing tasks with priorities, statuses, tags, and due dates. It's designed to help you organize and prioritize your tasks efficiently with ease of use and flexibility.


🚀 Features

  • Add Tasks: Create tasks with descriptions, priorities, due dates, tags, and statuses.
  • Edit Tasks: Modify existing tasks interactively.
  • List Tasks: Display tasks sorted by priority, with optional filtering by status or tags.
  • Search and Filter: Search tasks by keywords or filter them by status and tags.
  • Export Tasks: Export tasks to various formats, including CSV, JSON, and YAML.
  • Archive Tasks: Archive completed tasks to keep your workspace clean.
  • Task Completion: Mark tasks as complete or reopen them if needed.
  • Configurable: Customize task directories and settings through a configuration file (config.yaml).

📦 Installation

You can install Priority Manager from PyPI:

pip install priority-manager

Or upgrade

pip install --upgrade priority-manager

Update pip if Necessary

pip install --upgrade pip

🛠️ Usage

After installation, you can use the priority-manager command. Here are some basic commands:

General Help

priority-manager --help

Add a Task

priority-manager add "Finish the report"

You'll be prompted to provide additional details such as priority, description, due date, tags, and status.

List Tasks

priority-manager ls

List all tasks sorted by priority.

Filter by Status

priority-manager ls --status "In Progress"

Edit a Task

priority-manager edit

You’ll be prompted to select a task and edit its details interactively.

Complete a Task

priority-manager complete

Mark a task as completed.

Archive Tasks

priority-manager archive

Move completed tasks to the archive directory.

Export Tasks

Export tasks to CSV, JSON, or YAML:

priority-manager export --format csv

Available formats: csv, json, yaml.


⚙️ Configuration

config.yaml

The tool uses a config.yaml file for customizable settings. The default config.yaml looks like this:

directories:
  tasks_dir: "tasks"
  archive_dir: "archive"
  test_tasks_dir: "tests/test_tasks"
  test_archive_dir: "tests/test_archive"

statuses:
  - "To Do"
  - "In Progress"
  - "Blocked"
  - "Complete"
  - "Archived"

export_files:
  csv: "tasks_export.csv"
  json: "tasks_export.json"
  yaml: "tasks_export.yaml"

defaults:
  description: "No description"
  due_date: "No due date"
  tags: ""
  status: "To Do"

🧪 Testing

Run tests using pytest:

TEST_MODE=true pytest

Ensure all dependencies are installed:

pip install pytest

🤝 Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the Repository.
  2. Create a New Branch: git checkout -b feature-name.
  3. Make Changes and Commit: git commit -m "Add new feature".
  4. Push to the Branch: git push origin feature-name.
  5. Create a Pull Request.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.


📝 Author

David Chincharashvili
Email: davidchincharashvili@gmail.com
GitHub: davidtbilisi


🌟 Acknowledgments

  • Built with Click for CLI functionality.
  • YAML parsing powered by PyYAML.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

priority_manager-0.1.12.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

priority_manager-0.1.12-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file priority_manager-0.1.12.tar.gz.

File metadata

  • Download URL: priority_manager-0.1.12.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.10

File hashes

Hashes for priority_manager-0.1.12.tar.gz
Algorithm Hash digest
SHA256 94a38317ebbb4cdac979f50d302096581327535526121e751738bf22d3034992
MD5 a0f1005aa86e49182e5fa2708d5dc571
BLAKE2b-256 3a4453e6a5e4caeb7b73eac9701db10aac77e9909632eba44b9f3bf0b2985fcd

See more details on using hashes here.

File details

Details for the file priority_manager-0.1.12-py3-none-any.whl.

File metadata

File hashes

Hashes for priority_manager-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 7568300f18bd8b0f662e456d199f00017f1a41dcece1cfd75bb85879b8494f49
MD5 d9d76ed0737ec28e73761397043b0f4a
BLAKE2b-256 933c0407984d0cf6e084172d2ccf8a7596ad781f716b25d7d196ac475400a748

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page