From b49f1524e250764592ff132af8fb0d39182620f7 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 29 Apr 2024 06:20:41 +0200 Subject: Adding upstream version 0.9.0. Signed-off-by: Daniel Baumann --- docs/installation.rst | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 docs/installation.rst (limited to 'docs/installation.rst') diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..563ff57 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,77 @@ +============ +Installation +============ + +You can download a tarball_ from Github, checkout the latest `git tag`_ or fetch +the artifacts from `project page`_ on PyPI. + +The recommended way is to checkout the git tags, as they are PGP signed with one +of the following keys: + +- |3DCE51D60930EBA47858BA4146F633CBB0EB4BF2|_ *(Filipe Laíns)* + +``build`` may also be installed via `pip`_ or an equivalent: + +.. code-block:: sh + + $ pip install build + +.. tip:: + If you prefer, or are already using virtualenv_ in your workflow, you can + install ``build`` with the optional ``virtualenv`` dependency: + + .. 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). + +Bootstrapping +============= + +This package can build itself with only the ``toml`` and ``pep517`` +dependencies. The ``--skip-dependency-check`` flag should be used in this +case. + +On Python 3.10 and older, we have a dependency on tomli_, but toml_ can be +used instead, which may make bootstrapping easier. + + +Compatibility +============= + +``build`` is verified to be compatible with the following Python +versions: + +- 2.7 +- 3.5 +- 3.6 +- 3.7 +- 3.8 +- 3.9 +- PyPy(2) +- PyPy3 + + +.. _pipx: https://github.com/pipxproject/pipx +.. _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/ + +.. _tomli: https://github.com/hukkin/tomli +.. _toml: https://github.com/uiri/toml + + +.. |3DCE51D60930EBA47858BA4146F633CBB0EB4BF2| replace:: ``3DCE51D60930EBA47858BA4146F633CBB0EB4BF2`` +.. _3DCE51D60930EBA47858BA4146F633CBB0EB4BF2: https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3dce51d60930eba47858ba4146f633cbb0eb4bf2 -- cgit v1.2.3