Skip to content

converted README to reStructuredText and version as plain text file#663

Merged
thinkingserious merged 4 commits intosendgrid:v4from
StrikerRUS:pypi_v4
Oct 23, 2018
Merged

converted README to reStructuredText and version as plain text file#663
thinkingserious merged 4 commits intosendgrid:v4from
StrikerRUS:pypi_v4

Conversation

@StrikerRUS
Copy link
Contributor

@StrikerRUS StrikerRUS commented Oct 9, 2018

This is the copy of #634 PR, but against v4 branch

Important: 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 in v4 branch.

Checklist

  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the [Contribution Guide] and my PR follows them.
  • I updated my branch with the master branch.
  • I have added tests that prove my fix is effective or that my feature works
  • [n/a] I have added necessary documentation about the functionality in the appropriate .md file
  • [n/a] I have added in line documentation to the code I modified

Short description of what this PR does:

  • simplify processing of __version__ attribute by retrieving it from the plain text file, not by executing the .py module.
  • convert README.md to README.rst (appearance can be checked in this branch https://github.com/StrikerRUS/sendgrid-python/blob/pypi_v4/README.rst), so register.py is not needed anymore.
  • add Python versions badge.
    https://img.shields.io/pypi/pyversions/sendgrid.svg
  • add PyPI version badge.
    https://img.shields.io/pypi/v/sendgrid.svg

@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 9, 2018
@StrikerRUS StrikerRUS mentioned this pull request Oct 9, 2018
Closed
4 tasks
@codecov
Copy link

codecov bot commented Oct 9, 2018 •
edited
Loading

Codecov Report

Merging #663 into v4 will decrease coverage by 0.03%.
The diff coverage is 100%.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
sendgrid/sendgrid.py 85.71% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 63b8134...0dd1c3a. Read the comment docs.

@meahow
Copy link
Contributor

meahow commented Oct 9, 2018

Why change the README format?

@StrikerRUS
Copy link
Contributor Author

StrikerRUS commented Oct 9, 2018

@meahow

so register.py is not needed anymore.

@thinkingserious
Copy link
Contributor

thinkingserious commented Oct 9, 2018

@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!

@StrikerRUS StrikerRUS mentioned this pull request Oct 9, 2018
Merged
4 tasks
@meahow
Copy link
Contributor

meahow commented Oct 9, 2018

@thinkingserious The only issue I have with this is that MD syntax is a bit simpler/clearer.

FYI pypi now supports MD but:

  • you need python 3.x (probably only for creating a package)
  • you need to upload the package with twine

More info here

@agnesjang98 agnesjang98 added hacktoberfest difficulty: medium fix is medium in difficulty labels Oct 11, 2018
@thinkingserious
Copy link
Contributor

thinkingserious commented Oct 11, 2018

Hello @StrikerRUS,

Thanks again for the PR!

It's HACKTOBERFEST! We want to show our appreciation by sending you some special Hacktoberfest swag. If you have not already, could you please fill out this form so we can send it to you? Thanks!

Team SendGrid DX

@agnesjang98 agnesjang98 added the type: community enhancement feature request not on Twilio's roadmap label Oct 11, 2018
@misterdorm misterdorm added status: work in progress Twilio or the community is in the process of implementing and removed status: code review request requesting a community code review or review from Twilio labels Oct 19, 2018
@thinkingserious thinkingserious merged commit edd02e4 into sendgrid:v4 Oct 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@misterdorm misterdorm misterdorm approved these changes

Assignees

No one assigned

Labels

difficulty: medium fix is medium in difficulty status: work in progress Twilio or the community is in the process of implementing type: community enhancement feature request not on Twilio's roadmap

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@StrikerRUS @meahow @thinkingserious @misterdorm @agnesjang98