Skip to content

Correct statement on PEP-518 #1482

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

Closed
wants to merge 2 commits into from
Closed

Correct statement on PEP-518 #1482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bcbbe2
Correct statement on PEP-518
nuno-andre Dec 7, 2019
9a2ef66
Update CONTRIBUTORS
nuno-andre Dec 7, 2019
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
1 change: 1 addition & 0 deletions CONTRIBUTORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ Monty Taylor
Morgan Fainberg
Nick Douma
Nick Prendergast
Nuno André Novo
Oliver Bestwalter
Pablo Galindo
Paweł Adamczak
Expand Down
11 changes: 4 additions & 7 deletions docs/example/basic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,15 @@ The environment ``py`` uses the version of Python used to invoke tox.
However, you can also create your own test environment names,
see some of the examples in :doc:`examples <../examples>`.

pyproject.toml tox legacy ini
pyproject.toml legacy tox ini
-----------------------------

The tox configuration can also be in ``pyproject.toml`` (if you want to avoid an extra file).
The tox configuration can also be in ``pyproject.toml`` (the `Python's standard`_ configuration file for software packages).

Currently only the old format is supported via ``legacy_tox_ini``, a native implementation is planned though.

.. code-block:: toml

[build-system]
requires = [ "setuptools >= 35.0.2", "wheel >= 0.29.0"]
build-backend = "setuptools.build_meta"

[tool.tox]
legacy_tox_ini = """
[tox]
Expand All @@ -86,7 +82,8 @@ Currently only the old format is supported via ``legacy_tox_ini``, a native impl
commands = pytest
"""

Note that when you define a ``pyproject.toml`` you must define the ``build-requires`` section per PEP-518.
.. _Python's standard:
https://www.python.org/dev/peps/pep-0518

specifying a platform
-----------------------------------------------
Expand Down