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, and add badges. #404

Merged
merged 4 commits into from
Dec 28, 2022

Conversation

junkmd
Copy link
Collaborator

@junkmd junkmd commented Dec 12, 2022

see #399.

Announcements of plan for dropping Python2(#392) would be added in next my PR.

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

junkmd commented Dec 12, 2022

@vasily-v-ryabov

Please review this.

junkmd added a commit to junkmd/pywinauto that referenced this pull request Dec 12, 2022
@junkmd
Copy link
Collaborator Author

junkmd commented Dec 13, 2022

@junkmd
Copy link
Collaborator Author

junkmd commented Dec 15, 2022

After seeing @jaraco 's review in #405, I'm starting to think that I shouldn't change setup.py in this PR.

So, I have revert the changes on setup.py for now.
Nevertheless, the PyPI version badge left it as it is since it allows us to distinguish between 2.7 support and not.
I will investigate in my free time what format of Python versions to support in README.md would be effective.

I will include the supported Python versions in the README.md in the next PR.

@junkmd junkmd changed the title update README.md, and update setup.py for rendering the PyPI version badge. update README.md, and add badges. Dec 15, 2022
junkmd added a commit to junkmd/pywinauto that referenced this pull request Dec 15, 2022
Copy link
Collaborator

@vasily-v-ryabov vasily-v-ryabov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks good. Just a few minor updates would make it better. Thank you for all the efforts!

README.md Outdated

Contribute using the `source repository and issue tracker
<https://github.com/enthought/comtypes/>`_ on GitHub.
This package works on only Windows.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar: it should be on Windows only

README.md Outdated
Contribute using the `source repository and issue tracker
<https://github.com/enthought/comtypes/>`_ on GitHub.
This package works on only Windows.
- [`comtypes==1.1.7`](https://pypi.org/project/comtypes/1.1.7/) is the last version of supporting Windows CE.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-> the last version supporting Windows CE

README.md Outdated

https://lists.sourceforge.net/lists/listinfo/comtypes-users/
Binary installers for the latest released version are available at the [Python Package Index (PyPI)](https://pypi.org/project/comtypes).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does it mean "binary" for source only package? Do you mean wheel packages? I'd suggest to leave just An installer for the latest released version is ...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have seen packages that use this wording (such as pandas) and I thought it may be customary in Python communities.

Your suggestion is more straightforward, so I will change it to that.

@junkmd
Copy link
Collaborator Author

junkmd commented Dec 27, 2022

I fixed them. Please review this.

@vasily-v-ryabov vasily-v-ryabov merged commit dac3a12 into enthought:master Dec 28, 2022
@junkmd junkmd deleted the update_readme_md branch December 28, 2022 21:31
jonschz pushed a commit to jonschz/comtypes that referenced this pull request Jan 23, 2023
* update `README.md`

* update `setup.classifiers` for rendering ver badge

* revert setup.py

* fix grammar and wording
@junkmd junkmd mentioned this pull request 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

Successfully merging this pull request may close these issues.

None yet

2 participants