Metadata-Version: 2.1
Name: todo-utils
Version: 0.1.1
Summary: Convenient tool for scanning entire codebase to find TODO and FIXME comments and then updating the TODO.md.
Home-page: https://github.com/jai-python3/todo-utils
Author: Jaideep Sundaram
Author-email: jai.python3@gmail.com
License: UNKNOWN
Keywords: todo_utils
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
License-File: AUTHORS.rst
Requires-Dist: Click>=7.0
Requires-Dist: PyYAML
Requires-Dist: Rich
Requires-Dist: pydantic

==========
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`:

.. code-block:: 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.


