Skip to main content

Enforce ownership and ticketing of TODO notes.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for flake8-todo-ticket, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size flake8_todo_ticket-0.1.0-py2.py3-none-any.whl (7.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size flake8-todo-ticket-0.1.0.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page