Skip to main content

flake8-todo-ticket

PyPI PyPI codecov CircleCI branch

Enforce ownership and ticketing of TODO notes.

This module provides a plugin for flake8, the Python code checker.

Installation

Install with pip:

pip install flake8-todo-ticket

The plugin officially supports Python >= 3.6 and flake8 >= 3.7. You may find other Python 3 versions work as well.

Usage

The plugin finds TODO comments without any indication as to why they exist.

def my_function():
    # TODO
    # ^ who knows why this is here?
    pass
./my_file.py:2:7: T400 Badly formatted TODO. Use TODO(name)[ticket_number]

To remove the error, add some basic information about this TODO:

def my_function():
    # TODO(tommilligan)[2856]
    #      ^ who owns this temporary workaround
    #                   ^ ticket number for this issue
    pass

Changelog

0.1.0

Features

  • first commit, based on flake8-fixme

Metadata

Release files for flake8-todo-ticket 0.1.0

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

Source distribution (sdist)

Source distribution for flake8-todo-ticket 0.1.0
File Size Uploaded Provenance Actions
flake8-todo-ticket-0.1.0.tar.gz 3.0 kB Without provenance Details for flake8-todo-ticket-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for flake8-todo-ticket 0.1.0
File Interpreter ABI Platform Actions
flake8_todo_ticket-0.1.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for flake8_todo_ticket-0.1.0-py2.py3-none-any.whl

Total release size: 10.5 kB

Release files / flake8-todo-ticket-0.1.0.tar.gz

Download URL flake8-todo-ticket-0.1.0.tar.gz
Size 3.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4bedd158f24f67246b738f51dcdd79fec248fd5b38a9be69213ef1c443adb341
BLAKE2b-256 checksum
How to use checksums
0477cbf65c33137c3c91f374a04a60e73bb43d70f598649af27014d9900cdc50
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

Release files / flake8_todo_ticket-0.1.0-py2.py3-none-any.whl

Download URL flake8_todo_ticket-0.1.0-py2.py3-none-any.whl
Size 7.5 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
1fdb613b0fddfc6bf66bbf85f3aa518b6bb1e8e75dc9fa58beacfd4a83b90c3f
BLAKE2b-256 checksum
How to use checksums
3bfcb79a36b2bc656b9f2d1f9c82f6094454a82b92213d44cd56e8151ea20376
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

Security for flake8-todo-ticket 0.1.0

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.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page