You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: package-structure-code/python-package-distribution-files-sdist-wheel.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ Project metadata used to be stored in either a setup.py file or a setup.cfg file
78
78
79
79
### An example - xclim
80
80
81
-
When you publish to PyPI, you will notice that each package has metadata listed. Let’s have a look at [xclim](https://pypi.org/project/xclim/), one of our [pyOpenSci packages](https://www.pyopensci.org/python-packages.html). Notice that on the PyPI landing page you see some metadata about the package including python, maintainer information and more. PyPI is able to populate this metadata because it was defined using correct syntax and classifiers by Xclim's maintainers, [pyproject.toml file](https://github.com/Ouranosinc/xclim/blob/master/pyproject.toml). This metadata when the xclim package is built, is translated into a distribution file that allows PyPI to read the metadata and print it out on their website.
81
+
When you publish to PyPI, you will notice that each package has metadata listed. Let's have a look at [xclim](https://pypi.org/project/xclim/), one of our [pyOpenSci packages](https://www.pyopensci.org/python-packages.html). Notice that on the PyPI landing page you see some metadata about the package including python, maintainer information and more. PyPI is able to populate this metadata because it was defined using correct syntax and classifiers by Xclim's maintainers, [pyproject.toml file](https://github.com/Ouranosinc/xclim/blob/master/pyproject.toml). This metadata when the xclim package is built, is translated into a distribution file that allows PyPI to read the metadata andprint it out on their website.
Copy file name to clipboardExpand all lines: tutorials/installable-code.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -80,7 +80,7 @@ To make your Python code installable you need to create a specific directory str
80
80
- Some code.
81
81
- An `__init__.py` file in your code directory.
82
82
83
-
The directory structure you’ll create in this lesson will look like this:
83
+
The directory structure you'll create in this lesson will look like this:
84
84
85
85
```bash
86
86
pyospackage/ # Your project directory
@@ -118,7 +118,7 @@ import pyospackage
118
118
119
119
The **pyproject.toml** file is:
120
120
121
-
- Where you define your project’s metadata (including its name, authors, license, etc)
121
+
- Where you define your project's metadata (including its name, authors, license, etc)
122
122
- Where you define dependencies (the packages that it depends on)
123
123
- Used to specify and configure what build backend you want to use to [build your package](../package-structure-code/python-package-distribution-files-sdist-wheel).
124
124
@@ -279,7 +279,7 @@ Python can support many different docstrings formats depending on the documentat
279
279
280
280
**pyOpenSci recommends using the NumPy Docstring convention.**
281
281
282
-
If you aren’t familiar with docstrings or typing yet, that is ok. You can review [this page in the pyOpenSci packaging guide](https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/document-your-code-api-docstrings.html) for an overview of both topics.
282
+
If you aren't familiar with docstrings or typing yet, that is ok. You can review [this page in the pyOpenSci packaging guide](https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/document-your-code-api-docstrings.html) for an overview of both topics.
The core information that you need in a `pyproject.toml` file in order to publish on PyPI is your **package's name** and the **version**. However, we suggest that you flesh out your metadata early on in the `pyproject.toml` file.
481
481
482
482
Once you have your project metadata in the pyproject.toml file, you will
483
-
rarely update it. In the next lesson you’ll add more metadata and structure to this file.
483
+
rarely update it. In the next lesson you'll add more metadata and structure to this file.
Copy file name to clipboardExpand all lines: tutorials/pyproject-toml.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ When creating your pyproject.toml file, consider the following:
40
40
***name=**
41
41
***version=**
42
42
3. You should add more metadata to the `[project]` table as it will make it easier for users to find your project on PyPI. And it will also make it easier for installers to understand how to install your package.
43
-
3. When you are adding classifiers to the **[project]** table, only use valid values from [PyPI’s classifier page](https://PyPI.org/classifiers/). An invalid value here will raise an error when you build and publish your package on PyPI.
43
+
3. When you are adding classifiers to the **[project]** table, only use valid values from [PyPI's classifier page](https://PyPI.org/classifiers/). An invalid value here will raise an error when you build and publish your package on PyPI.
44
44
4. There is no specific order for tables in the `pyproject.toml` file. However, fields need to be placed within the correct tables. For example `requires =` always need to be in the **[build-system]** table.
45
45
5. We suggest that you include your **[build-system]** table at the top of your `pyproject.toml` file.
0 commit comments