A python program to collect all your TODO(s)
Project description
GETODO
A python program to collect all your TODO(s)
getodo
is a python program that collects all your TODO(s) from a folder/file and list them for you as a file or in the terminal screen. getodo
makes it easy to keep track of your TODO(s)
Installation
- You can install
getodo
viapip
pip install getodo
-
You can also check out the releases page to download the latest version of
getodo
. Note that it downloads the source code ofgetodo
and you might need to check out this guide to run the source code. -
You can also clone this repository.Cloning the repository can give you access to unreleased versions and might not be stable. Check out this guide to run
getodo
if you have cloned it.
git clone https://github.com/vyshnav-vinod/getodo.git
Running from the source code
If you have either downloaded from the releases or cloned this repository, you might need to setup a few different things.
-
Go into the getodo folder
-
It is recommended to create a virtual environment before installing the packages.
python3 -m venv venv
- Install the required packages from
requirements.txt
pip install -r requirements.txt
- Run
getodo
using pythonpython getodo_cli.py input_path
Usage
If you have downloaded via pip
getodo input_path [options]
else
python getodo_cli.py input_path [options]
Replace input_path
with the path to the folder/file you want to parse. You can just type .
to parse the current directory for TODO(s)
Options
-h, --help
: Display the help command
-o, --output
: Write to the file provided here. If no file is specified, the program will write to todo.txt
-t, --term
: Display the TODO's in the terminal with colors
-i, --ignore
: Ignore parsing the directories/files provided as arguments to this option
Contributing
All contributions are welcome. You can submit a issue/bug or request for a feature or ask for help in the issues tab.
If you like to add a new feature or fix a bug, please checkout CONTRIBUTING guidelines.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.