Skip to content
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.

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

update README.md #399

Closed
junkmd opened this issue Dec 11, 2022 · 5 comments
Closed

update README.md #399

junkmd opened this issue Dec 11, 2022 · 5 comments
Labels
shared_info use cases, tips and troubleshoots
Milestone

Comments

@junkmd
Copy link
Collaborator

junkmd commented Dec 11, 2022

The README.md, that appears in the GitHub repository page and in the PyPI project page, contains outdated content that can be confusing to newcomers.

  • Is "Mailing list" alive?
    • I think platform for the community interaction should be unified with GitHub issue tracker.
    • If necessary, GitHub discussions could be adopted.
  • The supported Python versions are not written.
  • The writing style is old.
    • making effective use of markdown notation.
  • "in less than 10000 lines of code" is no longer.
    • But adding "(excluding tests and blank lines)", then falling within that range.
  • etc...

We must also mention the removal of Python2 support, which is addressed in #392.

Any opinions would be appreciated.

@junkmd junkmd added the shared_info use cases, tips and troubleshoots label Dec 11, 2022
@junkmd
Copy link
Collaborator Author

junkmd commented Dec 12, 2022

As I watched PEP8 being applied in #403, I wondered something.

In modern programming, as a well-known fact, fewer lines of code is not directly related to readability.
So "in less than xxx lines of code" might not be attractive.
Instead, it may discourage the implementation of new features and more fixing bugs.

@junkmd
Copy link
Collaborator Author

junkmd commented Dec 12, 2022

@vasily-v-ryabov

The badge displaying the PyPI version is rendered as follows:
PyPI - Python Version

I think it is necessary to set which 3.x is supported.

@vasily-v-ryabov
Copy link
Collaborator

Agree, we can set Py2.7 and Py3.7+ version in PyPI metadata (setup.py) similar to pywinauto's setup.py.

@vasily-v-ryabov
Copy link
Collaborator

vasily-v-ryabov commented Dec 12, 2022

This badge seems to read the metadata from PyPI.

P.S. for pywinauto: PyPI - Python Version

@junkmd
Copy link
Collaborator Author

junkmd commented May 27, 2023

#404 and #460 are merged.

@junkmd junkmd closed this as completed May 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
shared_info use cases, tips and troubleshoots
Projects
None yet
Development

No branches or pull requests

2 participants