Skip to main content

A small tool to extract TODOs

Project description

extract-todo

Python build pypi version

extract-todo is a simple commandline tool for the extraction of TODOs. It can extract TODOs from single-line-comments like:

    # TODO something todo

It prints the file, line number and the TODO text.

Installation

You need python3+ to run this tool. It can be installed from pypi with

pip install extract-todo

Usage

You can use this tool with the command

python -m extract_todo /path/to/file

or

extract-todo /path/to/file

It prints the filename, line number and the TODO text. Example output:

.\tests\files\test.py
  LINE 1:       test
  LINE 5:       test 2

Author and License

Copyright (C) Jens Wilberg July 2021

extract_todo.py is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

extract_todo.py is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with extract_todo.py.  If not, see <http://www.gnu.org/licenses/>.

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

extract-todo-0.3.1.tar.gz (18.1 kB view hashes)

Uploaded source

Built Distribution

extract_todo-0.3.1-py3-none-any.whl (22.3 kB view hashes)

Uploaded py3

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