suggestions for the repo

arthurdejong / python-stdnum

A Python library to provide functions to handle, parse and validate standard numbers.

https://arthurdejong.org/python-stdnum/

GNU Lesser General Public License v2.1

495 stars 205 forks source link

suggestions for the repo #280

Open vairag22 opened 2 years ago

vairag22 commented 2 years ago

Drop support for Python versions that have reached their EOL. Allowing support will only prolong use of unmaintained versions that may have vulnerabilities and it also stifles developers/contributors to use features provided by newer versions.
Allow static typing and use of black for code formatting.
Convert README to README.md or README.rst. The text is small and looks cramped up, and status of repo is also not shown.
Group supported stdnum modules in categories (this-country, International, Algorithms) on the README for better navigation.
Enable GitHub Discussions and Wiki.

arthurdejong commented 2 years ago

Hi @vairag22

Thanks. Reasonably recently we only dropped support for Python 2.6 and while I agree that there are some features that are available in newer versions of Python that would simplify some things I'm also pretty sure that some people are sadly stuck with Python versions that do not have any official support. I'd like to keep supporting Python 2.7 so long as it doesn't cost too much effort.

I personally dislike the formatting that black does to the code and I don't think it allows any configuration. It also adds about 10% to the total lines of code reducing readability is some cases and it conflicts with a lot of the checking that is done by flake8 already.

I'l look into improving the README (both in general and specifically for Github). Specifically the list of formats is much too long now but I'll experiment a bit with some restructuring.

vairag22 commented 2 years ago

I personally dislike the formatting that black does to the code and I don't think it allows any configuration.

Understandable. Yeah it does not allow any configuration but that's the whole point of black. Nevertheless some standard automated formatting is still needed; it is very tiresome to hand format everything after flake8 throws a bunch of error for double quotes, stray whitespaces etc. This is a problem for first-time and infrequent contributors.

CGarces commented 2 years ago

I have experience with github actions if you need support to automate some task.

The update process to update the databases how is triggered?
Github and website content are sync?

Feel free to use GitHub project boards to share some ideas about tasks and assign it to me.

JensHeinrich commented 6 months ago

I support the idea of adding static typing; it prevents so many errors