Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wasi-master/todot
A powerful tool to parse TODOs/FIXMEs etc. from source files
https://github.com/wasi-master/todot
python python3 todo todolist todolist-cli todot
Last synced: about 1 month ago
JSON representation
A powerful tool to parse TODOs/FIXMEs etc. from source files
- Host: GitHub
- URL: https://github.com/wasi-master/todot
- Owner: wasi-master
- License: mit
- Created: 2021-08-22T09:04:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-09-20T05:57:29.000Z (over 3 years ago)
- Last Synced: 2024-12-18T22:31:52.996Z (about 1 month ago)
- Topics: python, python3, todo, todolist, todolist-cli, todot
- Language: Python
- Homepage: https://wasi-master.github.io/todot
- Size: 351 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
todot
A powerful tool to parse TODOs/FIXMEs etc. from source files
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
todot is a powerful tool to parse TODOs/FIXMEs etc. from source files\
### Built With
* [python](https://www.python.org)
## Getting Started
To install todot:
### Prerequisites
You'll need to have [python 3.6+](https://www.python.org) installed in order to use the extension
### Installation
You'll need to install [python](https://www.python.org) in order to use the extension
Currently there are two ways to install todot (the `[rich]` part adds rich terminal support)
* Installing via pip
1. Directly installing via pip (Recommended)
```sh
pip install todot-python[rich]
```
or
```sh
pip install todot-python
```
2. Installing using pip and git
```sh
pip install "todot-python[rich] @ git+https://github.com/wasi-master/todot.git"
```
or
```sh
pip install git+https://github.com/wasi-master/todot.git
```
* Cloning then installing
1. Clone the repo
```sh
git clone https://github.com/wasi-master/todot.git
```
2. Install using pip
```sh
pip install .[rich]
```
or
```sh
pip install .
```
## Usage
Go in a terminal and run
```sh
todot
```
There are more options to configure that can be found in the [Documentation](https://wasi-master.github.io/todot#Configuration)
_For more examples such as github workflow, configuring via file, please refer to the [Documentation](https://wasi-master.github.io/todot/)_
## Roadmap
See the [todo list](https://github.com/wasi-master/todot/blob/main/TODO.md) for a list of features yet to be added (and known issues).
Also see the [open issues](https://github.com/wasi-master/todot/issues) issues.
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See [`LICENSE`](license.md) for more information.
## Contact
Project Link: [https://github.com/wasi-master/todot](https://github.com/wasi-master/todot)
Discord: [Wasi Master#6969](https://discord.com/users/723234115746398219)
Email: [[email protected]](mailto:[email protected])