Pypi Python

README files can help your users understand your project and can be used to set your project’s description on PyPI.This guide helps you create a README in a PyPI-friendly format and include your README in your package so it appears on PyPI.


Pypi Download

An interface in the Java programming language is an abstract type that is used to specify a behaviour that classes must implement. Each Python module is represented by a.pyi 'stub'. This is a normal Python file (i.e., it can be interpreted by Python 3), except all the methods are empty. This section covers how to use the public PyPI download statistics dataset to learn more about downloads of a package (or packages) hosted on PyPI. For example, you can use it to discover the distribution of Python versions used to download a package.

Creating a README file¶

README files for Python projects are often named README, README.txt, README.rst, or README.md.

For your README to display properly on PyPI, choose a markup language supported by PyPI.Formats supported by PyPI’s README renderer are:

  • plain text

  • reStructuredText (without Sphinx extensions)

  • Markdown (GitHub Flavored Markdown by default,or CommonMark)

It’s customary to save your README file in the root of your project, in the same directory as your setup.py file.


Including your README in your package’s metadata¶

To include your README’s contents as your package description,set your project’s Description and Description-Content-Type metadata,typically in your project’s setup.py file.

For example, to set these values in a package’s setup.py file,use setup()’s long_description and long_description_content_type.

Pypi Python

Set the value of long_description to the contents (not the path) of the README file itself.Set the long_description_content_type to an accepted Content-Type-style value for your README file’s markup,such as text/plain, text/x-rst (for reStructuredText), or text/markdown.


Pypi Python

If you’re using GitHub-flavored Markdown to write a project’s description, ensure you upgradethe following tools:


The minimum required versions of the respective tools are:

  • setuptools>=38.6.0

  • wheel>=0.31.0

  • twine>=1.11.0

Pypi Python

It’s recommended that you use twine to upload the project’s distribution packages:

For example, see this setup.py file,which reads the contents of README.md as long_descriptionand identifies the markup as GitHub-flavored Markdown:

Validating reStructuredText markup¶

If your README is written in reStructuredText, any invalid markup will preventit from rendering, causing PyPI to instead just show the README’s raw source.

Note that Sphinx extensions used in docstrings, such asdirectives and roles(e.g., “:py:func:`getattr`” or “:ref:`my-reference-label`”), are not allowed here and will result in errormessages like “Error:Unknowninterpretedtextrole'py:func'.”.

You can check your README for markup errors before uploading as follows:

Pypi Python-dotenv

  1. Install the latest version of twine;version 1.12.0 or higher is required:

  2. Build the sdist and wheel for your project as described underPackaging your project.

  3. Run twinecheck on the sdist and wheel:

    This command will report any problems rendering your README. If your markuprenders fine, the command will output CheckingdistributionFILENAME:Passed.