todot-python 0.1.0

A powerful tool to parse TODOs/FIXMEs etc. from source files

todot

A powerful tool to parse TODOs/FIXMEs etc. from source files
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

todot is a powerful tool to parse TODOs/FIXMEs etc. from source files\

Built With

• python

Getting Started

To install todot:

Prerequisites

You'll need to have python 3.6+ installed in order to use the extension

Installation

• Installing via pip

  1. Directly installing via pip (Recommended)

     pip install todot-python
     

  2. Installing using pip and git

     pip install git+https://github.com/wasi-master/todot.git
     

• Cloning then installing

  1. Clone the repo

     git clone https://github.com/wasi-master/todot.git
     

  2. Go to the cloned directory

     cd todot
     

  3. Install using pip

     pip install .
     

Usage

Go in a terminal and run

todot

There are more options to configure that can be found in the Documentation

For more examples such as github workflow, configuring via file, please refer to the Documentation

Roadmap

See the todo list for a list of features yet to be added (and known issues). Also see the open 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 for more information.

Contact

Project Link: https://github.com/wasi-master/todot

Discord: Wasi Master#6969

Email: [e-mail]