Skip to content
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

docs: document "virtualenv" extra dependency #254

Merged
merged 2 commits into from
Mar 9, 2021
Merged

docs: document "virtualenv" extra dependency #254

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d644c88
docs: document "virtualenv" extra dependency
abravalheri Mar 9, 2021
d1c2ee8
docs: use virtualenv's official link
abravalheri Mar 9, 2021
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
18 changes: 18 additions & 0 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,20 @@ the artifacts from `project page`_ on PyPI.

$ pip install build

.. tip::
If you prefer, or are already using virtualenv_ in your workflow, you can
install ``build`` with the optional ``virtualenv`` depedency:

.. code-block:: sh

$ pip install 'build[virtualenv]'

this way, ``build`` will use virtualenv_ for isolation, instead of venv_.
This can be particularly useful, for example, when using automation tools
that rely on virtualenv_, such as tox_, or when your operating system's
Python package does not include venv_ in the standard installation (such as
some versions of Ubuntu).

The recommended way is to checkout the git tags, as they are PGP signed with one
of the following keys:

Expand Down Expand Up @@ -44,6 +58,10 @@ versions:
.. _pip: https://github.com/pypa/pip
.. _PyPI: https://pypi.org/

.. _tox: https://tox.readthedocs.org/
.. _virtualenv: https://virtualenv.pypa.io
.. _venv: https://docs.python.org/3/library/venv.html

.. _tarball: https://github.com/pypa/build/releases
.. _git tag: https://github.com/pypa/build/tags
.. _project page: https://pypi.org/project/build/
Expand Down