-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Doc updates for pyproject.toml and instructions for pypi (#480)
* Adding docs for pyproject.toml, and some additional instructions for trusted publishing via pypi. * Update docs/practices/customizing_project.rst Co-authored-by: Melissa DeLucchi <[email protected]> * Apply suggestions from code review * Update docs/practices/customizing_project.rst --------- Co-authored-by: Melissa DeLucchi <[email protected]>
- Loading branch information
1 parent
70ce81d
commit 9409cac
Showing
3 changed files
with
29 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
Configuration with pyproject.toml | ||
=============================================================================== | ||
|
||
What is it? Why do it? | ||
------------------------------------------------------------------------------- | ||
|
||
The ``pyproject.toml`` file is used to define many different project configurations. | ||
It replaces the need for setup.py, requirements.txt, and other configuration files. | ||
|
||
A fundamental use for ``pyproject.toml`` is to define dependencies. You should | ||
make an effort to add all the required dependencies to the ``[dependencies]`` | ||
section of the file. The template also creates a section for dependencies used only in development: ``[project.optional-dependencies][dev]``. You can add additional sets of optional dependencies here, e.g. for extended feature sets. | ||
|
||
In addition to dependencies, ``pyproject.toml`` centralizes the project's | ||
configuration and makes it easier to manage. If you examine your ``pyproject.toml`` | ||
file, you'll see sections with titles like ``[tool.<blah>]``. These sections are | ||
used to configure tools that are used in the project that would otherwise require | ||
their own configuration files. | ||
|
||
A ``pyproject.toml`` file provides a vast number of customization options well | ||
beyond what can be covered here. For an in-depth look at how the file can be used | ||
and how it compares to the older ``setup.py`` checkout the | ||
`Python Packaging User Guide <https://packaging.python.org/en/latest/guides/writing-pyproject-toml/>`_. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters