Metadata-Version: 2.1
Name: python-todo-comments
Version: 0.2.3
Summary: A cli that will search for and parse TODO comments in a directory's python modules.
Home-page: https://github.com/dodget/python-todo-comments
License: MIT
Author: Tylor Dodge
Author-email: tdodge@nexamp.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Project-URL: Repository, https://github.com/dodget/python-todo-comments
Description-Content-Type: text/markdown

# Python # TODO:  


This project provides a cli that takes a directory as an argument, and returns the `# TODO:` comments from all the python modules under that directory.

It will output in a markdown-friendly way, and is meant as a repeatable way to keep on top of all of the little todos that are peppered throughout a project.


## Installation

`pip install python-todo-comments`



## Usage

The basic command is `py-todos` combined with the following arguments:

- No argument: will search and parse the current working directory
- `-d` or `--dir` will search and parse the directory provided
- `-h` or `--help` will provide the command's help context
