Python API

[pycqa]

Python API

[keleshev]

This is an interesting idea. What about a function check_files(list_of_files) that will return a list of style errors (class Error in pep257 source)? Objects of that class know how to print themselves nicely.

[JensRantil]

Sounds like a great and simple API. If it could be documentation in
the README that would be awesome. Do you need help with any of this?

On 28 jul 2012, at 16:07, Vladimir Keleshev
[email protected]
wrote:

This is an interesting idea. What about a function check_files(list_of_files) that will return a list of style errors (class Error in pep257 source)? Objects of that class know how to print themselves nicely.

---

Reply to this email directly or view it on GitHub:
#7 (comment)

[keleshev]

Great, implementing this will be a snap. Thanks for the suggestion, more of that is always welcome.

[keleshev]

I updated the master branch with function check_files(filenames).

It would be great to hear if you have any feedback on this (also documentation, etc). If all good, I will upload the new version on PyPI.

I would also appreciate any general feedback about pep257—I myself find it too strict for my other projects on github, but this kind of level of documenting can be appropriate for large-scale software.

[keleshev]

BTW, I decided that check_files should return list-of-strings instead of list-of-error-objects, because I don't want to expose the internal API.

[JensRantil]

Good morning (from Sweden),

It would be great to hear if you have any feedback on this (also documentation, etc). If all good, I will upload the new version on PyPI.

Awesome. I've been travelling throughout this weekend but will have a look at the patch as soon as I have time. This will be within the next few days.

I would also appreciate any general feedback about pep257—I myself find it too strict for my other projects on github, but this kind of level of documenting can be appropriate for large-scale software.

Sure! I'll make sure to submit any issues as soon as they pop up. If you/I find pep257 to be too strict, one option would be to go a similar route as pep8 by giving each warning/error a unique ID that can be suppressed/selected.

BTW, I decided that check_files should return list-of-strings instead of list-of-error-objects, because I don't want to expose the internal API.

Aight. Wise to expose less than more.

[JensRantil]

I've been travelling throughout this weekend but will have a look at the patch as soon as I have time. This will be within the next few days.

Finally got the time to have a look at the API. It works out great for me so far. Feel free to publish a new release of the package whenever you want to.

[JensRantil]

@halst closed the issue just now

New release published?

[keleshev]

Yes

pip install pep257==0.2.0

[JensRantil]

Yes

Sweet! Thanks!

[keleshev]

I'm reacting very slow on issues in this project—what about I simply give you push access?

[JensRantil]

I'm reacting very slow on issues in this project—what about I simply give you push access?

Sure! I'm not sure I'll be working on pep8 that much more, but if I can be of any support I guess it's for the better.

[keleshev]

Great, you're in.