PyCQA / PyCQA/flake8

No documentation on how to write plugins.

Open
#556 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component:docs
Dominant language
Python
Stars
3.8k
Forks
356
PR merge metrics
No merged PRs in 30d

Description

In GitLab by @graingert on Jan 18, 2017, 04:39

I currently maintain https://pypi.python.org/pypi/flake8-commas and I'm trying to port it to flake8 >=3.

I currently only need the simple tokenize token stream to work.

However there's no documentation on what I should do to change my plugin to work with flake8 3.

http://flake8.pycqa.org/en/latest/plugin-development/index.html#getting-started
and http://flake8.pycqa.org/en/latest/plugin-development/registering-plugins.html

mention adding an entry point 'X = flake8_example:ExamplePlugin',

but not what ExamplePlugin should look like.

Do I use a run method? __init__ ? etc.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the plugin-development getting-started and registering-plugins pages linked in the issue, focusing on the ExamplePlugin entry point. Document the plugin interface, including whether plugins use run or init, and explain the simple tokenize token-stream migration for flake8 3; done means a plugin author can implement and register a working example.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.