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

Migrated README to Markdown (PEP 566) #66

Merged
merged 3 commits into from Apr 2, 2018
Merged
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.
+48 −33
Diff settings

Always

Just for now

@@ -1,3 +1,6 @@
# Include the README
include *.md

# Include the license file
include LICENSE.txt

@@ -0,0 +1,37 @@
# A sample Python project

A sample project that exists as an aid to the [Python Packaging User
Guide][packaging guide]’s [Tutorial on Packaging and Distributing

This comment has been minimized.

Copy link
@di

di Mar 20, 2018

Member

Could you replace the character with ' here?

Projects][distribution tutorial].

This projects does not aim to cover best practices for Python project

This comment has been minimized.

Copy link
@di

di Mar 20, 2018

Member

There's a typo here that's not your fault, should be "this project".

development as a whole. For example, it does not provide guidance or tool
recommendations for version control, documentation, or testing.

[The source for this project is available here][src].

Most of the configuration for a Python project is done in the `setup.py` file,
an example of which is included in this project. You should edit this file
accordingly to adapt this sample project to your needs.

----

This is the README file for the project.

The file should use UTF-8 encoding and can be written using
[reStructuredText][rst] or [markdown][md use] with the appropriate [key set][md
use]. It will be used to generate the project webpage on PyPI and will be
displayed as the project homepage on common code-hosting services, and should be
written for that purpose.

Typical contents for this file would include an overview of the project, basic
usage examples, etc. Generally, including the project changelog in here is not a
good idea, although a simple “What's New” section for the most recent version
may be appropriate.

[packaging guide]: https://twitter.com/mcclure111/status/975031304742895616
[distribution tutorial]: https://twitter.com/mcclure111/status/975031304742895616
[src]: https://twitter.com/mcclure111/status/975031304742895616
[rst]: https://twitter.com/mcclure111/status/975031304742895616
[md]: https://tools.ietf.org/html/rfc7764#section-3.5 "CommonMark variant"
[md use]: https://packaging.python.org/specifications/core-metadata/#description-content-type-optional

This file was deleted.

Oops, something went wrong.
@@ -14,7 +14,7 @@
here = path.abspath(path.dirname(__file__))

# Get the long description from the README file
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
with open(path.join(here, 'README.md'), encoding='utf-8') as f:
long_description = f.read()

# Arguments marked as "Required" below must be included for upload to PyPI.
@@ -57,6 +57,13 @@
# https://packaging.python.org/specifications/core-metadata/#description-optional
long_description=long_description, # Optional

# Denotes that our long_description is in Markdown; valid values are
# text/plain, text/x-rst, and text/markdown
#
# This field corresponds to the "Description-Content-Type" metadata field:
# https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
long_description_content_type='text/markdown', # Optional

This comment has been minimized.

Copy link
@di

di Mar 19, 2018

Member

Might want to add a note here that while this field is technically optional, it's required if you want a Markdown long_description.

This comment has been minimized.

Copy link
@di

di Mar 20, 2018

Member

Maybe change # Optional here to # Optional (see note above)?


# This should be a valid link to your project's main homepage.
#
# This field corresponds to the "Home-Page" metadata field:
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.