PyCQA / PyCQA/pycodestyle

Feature request: Command line option to pipe default configuration to stdout

Open
#739 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
5.2k
Forks
754
PR merge metrics
No merged PRs in 30d

Description

Could we add a command line option to output the default configuration similar to how pylint does (to get a config file containing the default config with e.g. pylint --generate-rcfile > .pylintrc)?

pylint -h
    --generate-rcfile   Generate a sample configuration file according to the
                        current configuration. You can put other options
                        before this one to get them in the generated
                        configuration.

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 pycodestyle's command-line handling and the existing default-configuration path; the issue does not name a file or test. Compare the requested behavior with pylint's --generate-rcfile example, and consider the work complete when an option writes a usable default configuration to stdout.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.