Skip to content

Commit 1a393bb

Browse files
committed
Add documentation about pyproject.toml
1 parent 8b99430 commit 1a393bb

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/source/configuration/development.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,22 @@ environment. Our
2424
[example `requirements.txt` file](https://github.com/binder-examples/requirements/blob/HEAD/requirements.txt)
2525
on GitHub shows a typical requirements file.
2626

27+
(pyproject)=
28+
29+
## `pyproject.toml` - Install Python packages
30+
31+
To install your reprository like a Python package, you may include a
32+
`pyproject.toml` file. `repo2docker`install `pyproject.toml` files by running
33+
`pip install -e .`.
34+
2735
(setup-py)=
2836

2937
## `setup.py` - Install Python packages
3038

39+
```{note}
40+
We recommend to use `pyproject.toml` as it is the recommended way since 2020 when PEPs [621](https://peps.python.org/pep-0621/) and [631](https://peps.python.org/pep-0631/) were accepted.
41+
```
42+
3143
To install your repository like a Python package, you may include a
3244
`setup.py` file. `repo2docker` installs `setup.py` files by running
3345
`pip install -e .`.

0 commit comments

Comments
 (0)