-
Notifications
You must be signed in to change notification settings - Fork 714
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
converted README to reStructuredText and version as plain text file #663
Conversation
Codecov Report
@@ Coverage Diff @@
## v4 #663 +/- ##
==========================================
- Coverage 84.38% 84.35% -0.04%
==========================================
Files 37 36 -1
Lines 967 965 -2
Branches 108 107 -1
==========================================
- Hits 816 814 -2
Misses 93 93
Partials 58 58
Continue to review full report at Codecov.
|
Why change the README format? |
|
@meahow, .rst is the format PyPi supports. Supporting this natively simplifies things. As @StrikerRUS said, now there is no need for converting the .md to .rst with register.py. Do you see any issue with this approach? Thanks! |
@thinkingserious The only issue I have with this is that MD syntax is a bit simpler/clearer. FYI pypi now supports MD but:
More info here |
Hello @StrikerRUS, |
This is the copy of #634 PR, but against
v4
branchImportant: content of README was taken from
master
branch, since there are more recent fixes and tracking of all of them will be lost after converting the format of the file, with applied patch for recent Python version update inv4
branch.Checklist
Short description of what this PR does:
__version__
attribute by retrieving it from the plain text file, not by executing the.py
module.README.md
toREADME.rst
(appearance can be checked in this branch https://github.com/StrikerRUS/sendgrid-python/blob/pypi_v4/README.rst), soregister.py
is not needed anymore.