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

Commit bb38e3c

Browse filesBrowse files
authored
Add a small section describing pyproject.toml (empa-scientific-it#231)
1 parent b686300 commit bb38e3c
Copy full SHA for bb38e3c

File tree

Expand file treeCollapse file tree

1 file changed

+8
-2
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+8
-2
lines changed

‎modules_and_packages.ipynb

Copy file name to clipboardExpand all lines: modules_and_packages.ipynb
+8-2Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -731,6 +731,14 @@
731731
"\n",
732732
"To make the package installable, we need to do a few more things.\n",
733733
"Typically, this is done by creating the `pyproject.toml` file.\n",
734+
"`pyproject.toml` is a configuration file that contains the build system requirements and the package metadata.\n",
735+
"It is used by the build tools like `flit` or `poetry` to build and install the package.\n",
736+
"It is also used by other tools like `black` and `mypy` to configure their behaviour.\n",
737+
"\n",
738+
"The [`toml` format](https://toml.io/) is a configuration file format that is easy to read and write for humans (unlike `json`).\n",
739+
"It is quite flexible but not as complex as the `yaml` format.\n",
740+
"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",
741+
"\n",
734742
"\n",
735743
"Here is a minimal example of the `pyproject.toml`: \n",
736744
"\n",
@@ -814,7 +822,6 @@
814822
]
815823
},
816824
{
817-
"attachments": {},
818825
"cell_type": "markdown",
819826
"metadata": {},
820827
"source": [
@@ -839,7 +846,6 @@
839846
]
840847
},
841848
{
842-
"attachments": {},
843849
"cell_type": "markdown",
844850
"metadata": {
845851
"tags": []

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.