Skip to content

updates to the develop mode section of the distribution tutorial #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
qwcode merged 1 commit into from
Oct 3, 2015
Merged

updates to the develop mode section of the distribution tutorial #177

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 23 additions & 10 deletions source/distributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -526,33 +526,46 @@ For example::
Working in "Development Mode"
=============================

Although not required, it's common to locally install your project in "develop"
or "editable" mode while you're working on it. This allows the project to be
Although not required, it's common to locally install your project in "editable"
or "develop" mode while you're working on it. This allows your project to be
both installed and editable in project form.

Using "setup.py", run the following:
Assuming you're in the root of your project directory, then run:

::

python setup.py develop
pip install -e .


Or you can achieve the same result using :ref:`pip`:
Although somewhat cryptic, ``-e`` is short for ``--editable``, and ``.`` refers
to the current working directory, so together, it means to install the current
directory (i.e. your project) in editable mode. This will also install any
dependencies declared with "install_requires" and any scripts declared with
"console_scripts". Dependencies will not be installed in editable mode.

::
It's fairly common to also want to install some of your dependencies in editable
mode as well. For example, supposing your project requires "foo" and "bar", but
you want "bar" installed from vcs in editable mode, then you could construct a
requirements file like so::

pip install -e .
-e .
-e git+https://somerepo/bar.git#egg=bar

The first line says to install your project and any dependencies. The second
line overrides the "bar" dependency, such that it's fulfilled from vcs, not
PyPI. For more on requirements files, see the :ref:`Requirements File
<pip:Requirements Files>` section in the pip docs. For more on vcs installs,
see the :ref:`VCS Support <pip:VCS Support>` section of the pip docs.

Note that both commands will install any dependencies declared with
"install_requires" and also any scripts declared with "console_scripts".
Lastly, if you don't want to install any dependencies at all, you can run::

pip install -e . --no-deps


For more information, see the `Development Mode
<http://pythonhosted.org/setuptools/setuptools.html#development-mode>`_ section
of the `setuptools docs <http://pythonhosted.org/setuptools/setuptools.html>`_.


.. _`Packaging Your Project`:

Packaging your Project
Expand Down