todo-cli-jp 0.1.0

A simple Python To-Do List CLI

📝 todo-cli: Your Simple Command-Line To-Do App

Welcome to todo-cli, a straightforward command-line To-Do application crafted with Python. This app allows you to manage your tasks efficiently by adding, completing, and deleting them with ease. With local JSON storage, it's perfect for minimalists who appreciate the simplicity of the terminal.

Table of Contents

• Features
• Installation
• Usage
• Commands
• JSON Storage
• Contributing
• License
• Contact

Features

• Add Tasks: Quickly add new tasks to your to-do list.
• Complete Tasks: Mark tasks as completed with a simple command.
• Delete Tasks: Remove tasks that you no longer need.
• Local JSON Storage: Store your tasks in a JSON file for easy access and modification.
• Minimalist Design: Focus on your tasks without distractions.

Installation

To get started with todo-cli, follow these steps:

1. Clone the Repository:

   git clone https://github.com/lukosth/todo-cli.git
   cd todo-cli
   

2. Install Dependencies: Make sure you have Python 3.6 or higher installed. You can install the required packages using:

   pip install -r requirements.txt
   

3. Download the Latest Release: You can download the latest release here. Make sure to execute the downloaded file to run the application.

Usage

Once you have installed todo-cli, you can start using it right away. Open your terminal and navigate to the directory where you cloned the repository. Then, run the following command:

python todo.py

You will see a simple interface guiding you through the available commands.

Commands

Here are the primary commands you can use with todo-cli:

• Add a Task:

  add "Task description"
  

• Complete a Task:

  complete TASK_ID
  

• Delete a Task:

  delete TASK_ID
  

• List All Tasks:

  list
  

• Help:

  help
  

JSON Storage

todo-cli uses a local JSON file to store your tasks. This allows for easy access and modification of your to-do list. The JSON file is located in the same directory as the application. You can edit this file directly if needed, but it's recommended to use the app's commands for consistency.

Contributing

We welcome contributions to todo-cli! If you have suggestions or improvements, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Make your changes and commit them.
4. Push to your branch.
5. Create a pull request.

Your contributions help make todo-cli better for everyone.

License

todo-cli is open-source and available under the MIT License. Feel free to use, modify, and distribute it as you see fit.

Contact

For any questions or feedback, please reach out:

• GitHub: lukosth
• Email: [e-mail]

Thank you for checking out todo-cli! We hope it helps you stay organized and productive. Don't forget to visit the Releases section for updates and new features.

---

Happy Task Management! 🗂️