69 lines
2.0 KiB
ReStructuredText
69 lines
2.0 KiB
ReStructuredText
============
|
|
Installation
|
|
============
|
|
|
|
``build`` can be installed via `pip`_ or an equivalent:
|
|
|
|
.. code-block:: sh
|
|
|
|
$ pip install build
|
|
|
|
You can also check out the latest `git tag`_, download a tarball_ from GitHub, or
|
|
manually fetch the artifacts from the `project page`_ on PyPI. The git tags are
|
|
recommended for redistribution and are PGP-signed with one of the following keys:
|
|
|
|
- |3DCE51D60930EBA47858BA4146F633CBB0EB4BF2|_ *(Filipe Laíns)*
|
|
|
|
.. 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 only with the ``tomli`` (can be omitted in Python 3.11+)
|
|
and ``pyproject-hooks`` dependencies.
|
|
The ``--skip-dependency-check`` flag should be used in this case.
|
|
|
|
Compatibility
|
|
=============
|
|
|
|
``build`` is verified to be compatible with the following Python
|
|
versions:
|
|
|
|
- 3.7
|
|
- 3.8
|
|
- 3.9
|
|
- 3.10
|
|
- 3.11
|
|
- 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
|
|
|
|
|
|
.. |3DCE51D60930EBA47858BA4146F633CBB0EB4BF2| replace:: ``3DCE51D60930EBA47858BA4146F633CBB0EB4BF2``
|
|
.. _3DCE51D60930EBA47858BA4146F633CBB0EB4BF2: https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x3dce51d60930eba47858ba4146f633cbb0eb4bf2
|