Skip to content

Commit

Permalink
docs(python): suggest pyproject.toml instead of setup.py (#2488)
Browse files Browse the repository at this point in the history
* Python PEP621: Suggest pyproject.toml instead of setup.py

Modern Python projects favor configuring with `pyproject.toml` over the `setup.py`.

https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
> Starting with [PEP 621](https://peps.python.org/pep-0621), the Python community selected `pyproject.toml` as a standard way of specifying project metadata. `Setuptools` has adopted this standard and will use the information contained in this file as an input in the build process.

* fix markdown link

---------

Co-authored-by: Jeff Ching <[email protected]>
  • Loading branch information
cclauss and chingor13 authored Feb 27, 2025
1 parent 26e75d3 commit e3c9eb0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ Release Please automates releases for the following flavors of repositories:
| `expo` | [An Expo based React Native repository, with a package.json, app.json and CHANGELOG.md](https://github.com/dmi3y/expo-release-please-example) |
| `ocaml` | [An OCaml repository, containing 1 or more opam or esy files and a CHANGELOG.md](https://github.com/grain-lang/binaryen.ml) |
| `php` | A repository with a composer.json and a CHANGELOG.md |
| `python` | [A Python repository, with a setup.py, setup.cfg, CHANGELOG.md](https://github.com/googleapis/python-storage) and optionally a pyproject.toml and a &lt;project&gt;/\_\_init\_\_.py |
| `python` | [A Python repository with a pyproject.toml, &lt;project&gt;/\_\_init\_\_.py, CHANGELOG.md or optionally a setup.py, setup.cfg](https://github.com/googleapis/python-storage) |
| `R` | A repository with a DESCRIPTION and a NEWS.md |
| `ruby` | A repository with a version.rb and a CHANGELOG.md |
| `rust` | A Rust repository, with a Cargo.toml (either as a crate or workspace, although note that workspaces require a [manifest driven release](https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md) and the "cargo-workspace" plugin) and a CHANGELOG.md |
Expand Down

0 comments on commit e3c9eb0

Please sign in to comment.