summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorHarald Korneliussen <vintermann@gmail.com>2020-11-18 19:32:18 +0100
committerGitHub <noreply@github.com>2020-11-18 19:32:18 +0100
commitb20d12e1fb7132fada3e6b58ec1c1c0bd409c5f7 (patch)
treef1f071bd23194006e7f25ae11290ab4cf2a76588 /docs
parent5cf3865fd314ff630376de352dbf8067ceaaa10b (diff)
downloadpython-setuptools-git-b20d12e1fb7132fada3e6b58ec1c1c0bd409c5f7.tar.gz
Fixes syntax issues in quickstart (#2448)
Quotes in the name and packages field causes an "Invalid distribution name or version syntax" if you follow this quickstart guide directly. pep517.build also requires you to specify the directory.
Diffstat (limited to 'docs')
-rw-r--r--docs/userguide/quickstart.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst
index 697087ed..50a984ec 100644
--- a/docs/userguide/quickstart.rst
+++ b/docs/userguide/quickstart.rst
@@ -43,11 +43,11 @@ such as metadata, contents, dependencies, etc. Here we demonstrate the minimum
.. code-block:: ini
[metadata]
- name = "mypackage"
+ name = mypackage
version = 0.0.1
[options]
- packages = "mypackage"
+ packages = mypackage
install_requires =
requests
importlib; python_version == "2.6"
@@ -63,7 +63,7 @@ Then, you need an installer, such as `pep517 <https://pypi.org/project/pep517/>`
which you can obtain via ``pip install pep517``. After downloading it, invoke
the installer::
- python -m pep517.build
+ python -m pep517.build .
You now have your distribution ready (e.g. a ``tar.gz`` file and a ``.whl``
file in the ``dist`` directory), which you can upload to PyPI!