Skip to main content

Convenient tool for scanning entire codebase to find TODO and FIXME comments and then updating the TODO.md.

Project description

TODO Utils

Convenient tool for scanning entire codebase to find TODO and FIXME comments and then updating the TODO.md.

Console Scripts

The following exported console scripts are available:

  • todo-pre-commit-scan

  • todo-update-todo-md

  • todo-scan-codebase

For the todo-pre-commit-scan, add the following to your .pre-commit-config.yaml:

repos:
  - repo: local
    hooks:
      - id: todo-pre-commit-scan
        name: Check for TODOs with username
        entry: todo-pre-commit-scan
        language: system
        types: [text, python]

History

0.1.0 (2024-02-23)

  • First release on PyPI.

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

todo_utils-0.1.1.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

todo_utils-0.1.1-py2.py3-none-any.whl (13.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file todo_utils-0.1.1.tar.gz.

File metadata

  • Download URL: todo_utils-0.1.1.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for todo_utils-0.1.1.tar.gz
Algorithm Hash digest
SHA256 bcee616566edec720acecf6916affb21ff55d1a8f6849818b78de8e8554273ba
MD5 d0a42edb2ea6e14af7ed6599eb61f2aa
BLAKE2b-256 b96c4ae52e7693ed78f1222ec64e41663dc04b09580716d93f247308d9c9af45

See more details on using hashes here.

File details

Details for the file todo_utils-0.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: todo_utils-0.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for todo_utils-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a7e809ddb699a06088e6ed66f410bb6a028b5e4fd99c5710c2c4074e674a3fa9
MD5 ef8ad8280372bd7b9b7dff1d0a65546f
BLAKE2b-256 9617a66022f895683ecfdbb7e5c522004d862b56b8bf1175ee903568e244ab5f

See more details on using hashes here.

Supported by

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