https://github.com/p-nelly/task-cli
A lightweight Python CLI task management system for efficient task tracking and organization. Features include task creation, status updates, filtering, and persistent JSON storage. Built with Python's standard library - no dependencies required. Perfect for developers who prefer command-line productivity tools.
https://github.com/p-nelly/task-cli
cli-app productivity productivity-tools python task-management task-manager
Last synced: about 1 month ago
JSON representation
A lightweight Python CLI task management system for efficient task tracking and organization. Features include task creation, status updates, filtering, and persistent JSON storage. Built with Python's standard library - no dependencies required. Perfect for developers who prefer command-line productivity tools.
- Host: GitHub
- URL: https://github.com/p-nelly/task-cli
- Owner: P-Nelly
- License: mit
- Created: 2024-12-17T21:06:47.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-19T21:49:24.000Z (about 1 year ago)
- Last Synced: 2025-02-27T04:28:43.637Z (10 months ago)
- Topics: cli-app, productivity, productivity-tools, python, task-management, task-manager
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TASK-CLI
A Python-based command-line task management system that helps you organize and track tasks
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Project Structure](#project-structure)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
---
## Overview
Task-CLI is a command-line interface tool for managing tasks efficiently. Tasks are stored in a JSON file and can be easily managed through various commands. The application provides a simple yet powerful way to track your tasks' status and progress.
---
## Features
- **Task Creation & Management**: Create, update, and delete tasks
- **Status Tracking**: Mark tasks as todo, in-progress, or done
- **Persistent Storage**: All tasks are stored in a JSON file
- **Filtering**: List tasks by status
- **Command-line Interface**: Easy to use CLI with intuitive commands
---
## Project Structure
```
task-manager/
├── main.py
├── tasks.json
├── README.md
└── LICENSE
```
### Project Index
TASK-CLI/
__root__
main.py
Core application logic for task management
tasks.json
JSON storage for task data
---
## Getting Started
### Prerequisites
- Python 3.x installed
- No additional dependencies required - uses Python standard library
### Installation
1. Clone the repository:
```sh
❯ git clone https://github.com/p-nelly/task-cli.git
```
2. Navigate to the project directory:
```sh
❯ cd task-cli
```
### Usage
The task manager supports the following commands:
**Add a new task:**
```sh
❯ python main.py add "Task description"
```
**Update a task:**
```sh
❯ python main.py update "New description"
```
**Delete a task:**
```sh
❯ python main.py delete
```
**Mark task status:**
```sh
❯ python main.py mark-in-progress
❯ python main.py mark-done
```
**List tasks:**
```sh
❯ python main.py list # List all tasks
❯ python main.py list todo # List only todo tasks
❯ python main.py list in-progress # List only in-progress tasks
❯ python main.py list done # List only completed tasks
```
---
## Contributing
- [Join the Discussions](https://github.com/p-nelly/task-cli/discussions): Share your insights, provide feedback, or ask questions.
- [Report Issues](https://github.com/p-nelly/task-cli/issues): Submit bugs found or log feature requests.
- [Submit Pull Requests](https://github.com/p-nelly/task-cli/pulls): Review open PRs, and submit your own PRs.
Contributing Guidelines
1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
2. **Clone Locally**: Clone the forked repository to your local machine.
3. **Create a New Branch**: Always work on a new branch.
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
6. **Push to GitHub**: Push the changes to your forked repository.
7. **Submit a Pull Request**: Create a PR against the original project repository.
---
## License
This project is licensed under the MIT License. For more details, refer to the [LICENSE](LICENSE) file.
---
## Roadmap.sh project
This project was created for roadmap.sh
https://roadmap.sh/projects/task-tracker
---