Skip to main content

A cli that will search for and parse TODO comments in a directory's python modules.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-todo-comments-0.2.4.tar.gz (2.2 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page