summaryrefslogtreecommitdiff
path: root/docs/userguide
diff options
context:
space:
mode:
authoralvyjudy <alvyjudy@gmail.com>2020-05-25 21:32:01 -0400
committeralvyjudy <alvyjudy@gmail.com>2020-05-25 21:32:01 -0400
commitb13e4a2a96c2d88890157fdd0b116619436761c4 (patch)
treec0ebe131e319d2a6516b55611e7f5ee0dd42879a /docs/userguide
parent992ecc09a2aa08310ae9bba4865e54e157b581cb (diff)
downloadpython-setuptools-git-b13e4a2a96c2d88890157fdd0b116619436761c4.tar.gz
docs: add dev mode section in quickstart
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/quickstart.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/userguide/quickstart.txt b/docs/userguide/quickstart.txt
index 224be368..52829751 100644
--- a/docs/userguide/quickstart.txt
+++ b/docs/userguide/quickstart.txt
@@ -167,6 +167,26 @@ The data files must be specified via the distutils' ``MANIFEST.in`` file.
For more details, see :ref:`datafiles`
+Development mode
+================
+``setuptools`` allows you to install a package without copying any files
+to your interpretor directory (e.g. the ``site-packages`` directory). This
+allows you to modify your source code and have the changes take effect without
+you having to rebuild and reinstall. This is currently incompatible with
+PEP 517 and therefore it requires a ``setup.py`` script with the following
+content::
+
+ import setuptools
+ setuptools.setup()
+
+Then::
+
+ pip install --editable .
+
+This creates a link file in your interpretor site package directory which
+associate with your source code. For more information, see: (WIP)
+
+
Uploading your package to PyPI
==============================
After generating the distribution files, next step would be to upload your