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.24.tar.gz (12.8 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.24-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: priority_manager-0.1.24.tar.gz
  • Upload date:
  • Size: 12.8 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.24.tar.gz
Algorithm Hash digest
SHA256 fad007ad2c4bdb7a2d9187d1261c5bd429439c0e40d2ba71198e211a1028f1c2
MD5 502aa2794e54f39c03d5f94a1a380756
BLAKE2b-256 f573d5b629b39b7c9d5264e1b0864af712d44b45df61ea3dd9318a36dc648e47

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for priority_manager-0.1.24-py3-none-any.whl
Algorithm Hash digest
SHA256 3f60b0005f222b6ad2f9db7288d67f770ef03a84a4574c2e52de6b63e22deb70
MD5 b262c4deafc2b92be4ffc1927239c0a3
BLAKE2b-256 6fe192c1489189825395bf7bb0198f87ef6c921cde0b32fee85cc5fbedc9470b

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