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

Use the README file as the docs on PYPI #143

Merged
merged 2 commits into from
Oct 6, 2023

Conversation

HanslettTheDev
Copy link
Collaborator

@HanslettTheDev HanslettTheDev commented Oct 5, 2023

Summary

This PR aims to provide a means for pyafipws to use the README.md file to be used as it's documentation when deployed to pypi.

Checklist

  • Classes, Variables, function and methods logic ok
  • Comments written explaining what the code does
  • All python code is PEP8 compliant (run black .)
  • No lint issues (run flake8)

Manual test evidence

Here is evidence from twine when checking the packages in the dist/* folder

image

image

image

Copy link
Member

@reingart reingart left a comment

Choose a reason for hiding this comment

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

Thanks!

For the record, there was an error with pathlib.Path as it is not in all python 2.7 installations (but now it should work with just open)

Eventually we should get rid of this setup code at all with pyproject.toml

@reingart reingart merged commit 8f8a5bf into PyAr:main Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants