8000 suggestions for the repo · Issue #280 · arthurdejong/python-stdnum · GitHub
[go: up one dir, main page]
Skip to content

suggestions for the repo #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
vairag22 opened this issue Sep 30, 2021 · 4 comments
Open

suggestions for the repo #280

vairag22 opened this issue Sep 30, 2021 · 4 comments

Comments

@vairag22
Copy link
Contributor
vairag22 commented Sep 30, 2021 •
edited
Loading
  • 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
Copy link
Owner

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.

arthurdejong added a commit that referenced this issue Oct 3, 2021
@arthurdejong
Rename README to README.md
3406c24 
Mostly to please GitHub.

See #280
@vairag22
Copy link
Contributor Author
vairag22 commented Oct 3, 2021

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
Copy link
CGarces commented Oct 4, 2021

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@arthurdejong @CGarces @JensHeinrich @vairag22
0