summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2024-02-07 18:11:30 -0700
committerMichael Merickel <michael@merickel.org>2024-02-07 18:11:30 -0700
commitb2c8840708079ad645cd7abea45634d4b8686eb8 (patch)
tree55a4f6567058f29720e9e10dab39d13c606a54a5
parenta31db999eaecb393b1d0c10058b1d43be076a4f6 (diff)
downloadpyramid-b2c8840708079ad645cd7abea45634d4b8686eb8.tar.gz
pyramid-b2c8840708079ad645cd7abea45634d4b8686eb8.tar.bz2
pyramid-b2c8840708079ad645cd7abea45634d4b8686eb8.zip
improve the distributing.rst
-rw-r--r--docs/tutorials/wiki2/distributing.rst26
1 files changed, 20 insertions, 6 deletions
diff --git a/docs/tutorials/wiki2/distributing.rst b/docs/tutorials/wiki2/distributing.rst
index 08f7d4d48..8840d5f7c 100644
--- a/docs/tutorials/wiki2/distributing.rst
+++ b/docs/tutorials/wiki2/distributing.rst
@@ -29,11 +29,25 @@ On Windows:
%VENV%\Scripts\pip install build
%VENV%\Scripts\python -m build
-Upon successfull completion, a "sdist" and a "wheel" will be output to the ``dist`` subdirectory.
-These artifacts are uploadable to `PyPI <https://pypi.org/>`_ using a tool like ``twine``.
-You should be able to create a brand new virtualenv and ``pip install`` the sdist or wheel.
-Note that the ``production.ini`` is not part of the distribution.
-This file is considered to be defined by the "user" of your application, not part of the application itself.
-If you'd like to help a user out, consider defining a new CLI script that can render a config file for them!
+The output of such a command will be something like:
+
+.. code-block:: text
+
+ * 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`` (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.
+These artifacts are also uploadable to `PyPI <https://pypi.org/>`_, or another package index, using a tool like ``twine``.
+
+Note that the config files, such as ``production.ini`` are not part of the distribution.
+These files are considered to be defined by the "user" of your application and not part of the application itself.
+If you'd like to help a user out, consider defining a new CLI script similar to ``initialize_tutorial_db`` that can render a config file for them!
Please learn more about distributing an application from the `Python Packaging User Guide <https://packaging.python.org/en/latest/tutorials/packaging-projects/>`_.