diff options
Diffstat (limited to 'docs/tutorials/wiki/distributing.rst')
| -rw-r--r-- | docs/tutorials/wiki/distributing.rst | 30 |
1 files changed, 17 insertions, 13 deletions
diff --git a/docs/tutorials/wiki/distributing.rst b/docs/tutorials/wiki/distributing.rst index c23f79b5a..a423e8b96 100644 --- a/docs/tutorials/wiki/distributing.rst +++ b/docs/tutorials/wiki/distributing.rst @@ -4,33 +4,37 @@ Distributing Your Application ============================= -Once your application works properly, you can create a :term:`distribution` from it by using the ``setup.py sdist`` command. -The following commands assume your current working directory contains the ``tutorial`` package and the ``setup.py`` file. +Once your application works properly, you can create a :term:`distribution` from it by using the PyPA ``build`` command. +The following commands assume your current working directory contains the ``tutorial`` package and its ``pyproject.toml`` file. On Unix: .. code-block:: bash - $VENV/bin/python setup.py sdist + $VENV/bin/pip install build + $VENV/bin/python -m build On Windows: .. code-block:: doscon - %VENV%\Scripts\python setup.py sdist + %VENV%\Scripts\pip install build + %VENV%\Scripts\python -m build The output of such a command will be something like: .. code-block:: text - running sdist - # more output - creating dist - Creating tar archive - removing 'tutorial-0.0' (and everything under it) + * Creating venv isolated environment... + * Installing packages in isolated environment... (setuptools) + * Getting build dependencies for sdist... + ... + removing build/bdist.linux-x86_64/wheel + Successfully built tutorial-0.0.tar.gz and tutorial-0.0-py3-none-any.whl + This command creates a subdirectory named ``dist``. -Inside that is a tarball named ``tutorial-0.0.tar.gz``, which is the :term:`distribution` of your application. -You can send this file to your friends to show them your cool new application. -They should be able to install it by pointing the ``pip install`` command directly at it. -Or you can upload it to `PyPI <https://pypi.org/>`_ and share it with the rest of the world, where it can be downloaded via ``pip install`` remotely like any other package people download from PyPI. +Inside that is a tarball named ``tutorial-0.0.tar.gz`` (the source :term:`distribution` of your application), as well ass ``tutorial-0.0-py3-none-any.whl`` (the binary :term:`distribution`). +You can send these files to your friends to show them your cool new application. +They should be able to install the app by pointing the ``pip install`` command directly at one of them. +Or you can upload them to `PyPI <https://pypi.org/>`_ and share them with the rest of the world, where it can be downloaded via ``pip install`` remotely like any other package people download from PyPI. |