Skip to content

Commit

Permalink
Doc updates for pyproject.toml and instructions for pypi (#480)
Browse files Browse the repository at this point in the history
* 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
drewoldag and delucchi-cmu authored Sep 30, 2024
1 parent 70ce81d commit 9409cac
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,5 @@ please :doc:`/source/contact`
practices/issue_pr_templating
practices/sphinx
practices/publishing_package
practices/customizing_project

23 changes: 23 additions & 0 deletions docs/practices/customizing_project.rst
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/>`_.
7 changes: 5 additions & 2 deletions docs/practices/pypi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,11 @@ To support this, you'll need to configure your repository.

* For previously unpublished packages: https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/
* For existing published packaged: https://docs.pypi.org/trusted-publishers/adding-a-publisher/

* When configuring your trusted publisher, the value to use for the "Workflow name" is "publish-to-pypi.yml".

* When configuring your trusted publisher

* Set the value of "Workflow name" to "publish-to-pypi.yml".
* Leave the value of "Environment name" blank.


Releasing new versions
Expand Down

0 comments on commit 9409cac

Please sign in to comment.