Skip to content

Commit ca4cb58

Browse files
pgadigetheacodes
authored andcommitted
Explain specific requirements for Markdown descriptions (#522)
* Explain specific requirements for Markdown descriptions * Rephrase and change to lowercase directive
1 parent f7166e6 commit ca4cb58

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

source/guides/making-a-pypi-friendly-readme.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,27 @@ Set the value of ``long_description`` to the contents (not the path) of the READ
4040
Set the ``long_description_content_type`` to an accepted ``Content-Type``-style value for your README file's markup,
4141
such as ``text/plain``, ``text/x-rst`` (for reStructuredText), or ``text/markdown``.
4242

43+
.. note::
44+
45+
If you're using GitHub-flavored Markdown to write a project's description, ensure you upgrade
46+
the following tools:
47+
48+
.. code-block:: bash
49+
50+
python3 -m pip install --user --upgrade setuptools wheel twine
51+
52+
The minimum required versions of the respective tools are:
53+
54+
- ``setuptools >= 38.6.0``
55+
- ``wheel >= 0.31.0``
56+
- ``twine >= 1.11.0``
57+
58+
It's recommended that you use ``twine`` to upload the project's distribution packages:
59+
60+
.. code-block:: bash
61+
62+
twine upload dist/*
63+
4364
For example, see this :file:`setup.py` file,
4465
which reads the contents of :file:`README.md` as ``long_description``
4566
and identifies the markup as GitHub-flavored Markdown:

0 commit comments

Comments
 (0)