Whatodo

Description

In software development and any other area of coding it is a common occerance to use comments for TODO and FIXME for two examples. It can be difficult with large files and/or large numbers of files to locate these comments.

whatodo is created to make locating theses comments easier. This app can read through any number of files and locate these comments returning the line number of the contents of the actual comment.

The application is written in pure Python with the help of the pygments library. With this library we are able to parse through more than 100+ languages, for a more detailed description see pygments docs

Usage

The most common use case would be scanning a whole source directory for tags, to achieve this you can do the following:

whatodo src/

For more info and additional options see whatodo -h

Options

- json
- keyword
- files

JSON

Changes the output format to json, useful for automating with other tools.

Keyword

The Keywords are the words searched for in the beginning of a comment to determine if this is a comment to extract.

Defaults to TODO, todo, FIXME

Files

The Files are the files searched through to locate comments with the above mentioned Keywords.

A list of files or directories to analyze and look for TODO’s. At least 1 file must be provided.

Installing

To install simply do:

pip install whatodo

License

MIT License for more details see /LICENSE

Metadata

Release files for whatodo 0.1.0a4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for whatodo 0.1.0a4
File	Interpreter	ABI	Platform	Reset
whatodo-0.1.0a4-py3-none-any.whl 12.7 kB Apr 23, 2015 Without provenance	Python 3	none	any	Details

Release files / whatodo-0.1.0a4-py3-none-any.whl

Download URL	whatodo-0.1.0a4-py3-none-any.whl
Size	12.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c52bb8e4b2cd08cadaffb8e1b1b2d1798ed956476fda1dfa3ae45ef5b54c0797`
BLAKE2b-256 checksum How to use checksums	`988770899efc9dece7e88e8ab7373afec8dc548f50b0cc25c6a187732d37aaca`
Upload date	Apr 23, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No

Security for whatodo 0.1.0a4

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.