Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Add a small section describing the pyproject.toml file #231

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

Merged
merged 1 commit into from
May 4, 2024
Merged

Add a small section describing the pyproject.toml file #231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions 10 modules_and_packages.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,6 +731,14 @@
"\n",
"To make the package installable, we need to do a few more things.\n",
"Typically, this is done by creating the `pyproject.toml` file.\n",
"`pyproject.toml` is a configuration file that contains the build system requirements and the package metadata.\n",
"It is used by the build tools like `flit` or `poetry` to build and install the package.\n",
"It is also used by other tools like `black` and `mypy` to configure their behaviour.\n",
"\n",
"The [`toml` format](https://toml.io/) is a configuration file format that is easy to read and write for humans (unlike `json`).\n",
"It is quite flexible but not as complex as the `yaml` format.\n",
"Another advangtage of the `toml` format is that it is pre-installed in Python, so you don't need to install any additional packages to use it.\n",
"\n",
"\n",
"Here is a minimal example of the `pyproject.toml`: \n",
"\n",
Expand Down Expand Up @@ -814,7 +822,6 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
Expand All @@ -839,7 +846,6 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {
"tags": []
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.