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
  • -o or --output will write the output to the provided filename
  • -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.3.0.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

python_todo_comments-0.3.0-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file python-todo-comments-0.3.0.tar.gz.

File metadata

  • Download URL: python-todo-comments-0.3.0.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.9 Darwin/21.4.0

File hashes

Hashes for python-todo-comments-0.3.0.tar.gz
Algorithm Hash digest
SHA256 32fff02827c6b8be40ddaeea8f9d6143c0bd8366dd2b3c6ae48fb8a1e5ac672e
MD5 997f11a66d040984581f3dc98e706dd7
BLAKE2b-256 74bc3018ebf8578dab3d2cea4170c5929ddcb21f449dc6372a012af5136ffb36

See more details on using hashes here.

File details

Details for the file python_todo_comments-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for python_todo_comments-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a604d4dc80cbb7ad07196eb0ed23a27e80c62246f660a047ffe38c332ec1150d
MD5 3fca4051edb1c5443b86aff10cab6ff3
BLAKE2b-256 75ab2d0b5e7188f03b9d0c3cb3fc523d9606584ac80fb10f47d973a28cee43c7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page