pep257 configuration file #58

Closed
kdeldycke opened this Issue Oct 7, 2013 · 14 comments

Projects

None yet

7 participants

@kdeldycke

pep8 has ~/.config/pep8.
PyLint has ~/.pylintrc.
Flake8 has ~/.config/flake8.
Even PyChecker had ~/.pycheckrc.

Why can't pep257 have a configuration file ?

@keleshev
Contributor
keleshev commented Oct 7, 2013

Sure! Pull requests are welcome ๐Ÿ˜‰

@kdeldycke

I'll wait for the merging of your rewrite branch.

In the mean time, do you have any preferences on the naming and default location ?

@keleshev
Contributor

~/.config/pep257 should be best. Do you know if pep8/pylint/flake8/pychecker use any local (per-project) config files? That could be interesting.

Ini-style config is probably the best choice, since it's supported by standard library. Take a look at this config example. It allows for configs like:

[pep257]
--explain
--ignore=D101,D202
--match='(?!test_).*\.py'
@sigmavirus24
Member

We honor setup.cfg if I remember correctly. Possibly also tox.ini but I think that was deprecated. I'm also not sure if we support ~/.config/flake8 any longer.

[#]: We == Flake8

@keleshev
Contributor

What do you use if not ~/.config/flake8. setup.cfg and tox.ini are also good ideas.

@adiroiban

Before having a configuration file, I prefer to have PEP257Checker(options). options can be a simple key/value dict of Bunch like object.

@adiroiban

btw. I am not using (or plan to use) pep256 directly from the command line. Rather I load a file in memory once and then send the content to many linters and checkers.

@treyhunner

I would like to see setup.cfg support. I have particular files I would like to omit from checking and I don't want to type them at the command line ever time.

@Nurdok
Member
Nurdok commented Jul 26, 2014

@kdeldycke are you working on this, or planning to?

@kdeldycke

@Nurdok not at all. Feel free to take over this issue ! :)

@oryband
oryband commented Dec 11, 2014

๐Ÿ‘ any progress on this?

@Nurdok
Member
Nurdok commented Dec 12, 2014

Not yet, but I consider this the next big thing.

On Thu, 11 Dec 2014 12:50 pm Ory Band notifications@github.com wrote:

[image: ๐Ÿ‘] any progress on this?

โ€”
Reply to this email directly or view it on GitHub
#58 (comment).

@Nurdok Nurdok modified the milestone: 0.4.0 Release Dec 31, 2014
@Nurdok Nurdok closed this Jan 2, 2015
@oryband
oryband commented Jan 2, 2015

Great. Could youp lease add documentation for this please? Specifically to the front page of this repo (README.md)

@sigmavirus24
Member

This is a better opportunity to start using readthedocs.org and have real documentation for this project.

@keleshev keleshev referenced this issue Jan 2, 2015
Closed

Real docs #88

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment