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: tutorials/create-python-package.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -85,7 +85,7 @@ Please select the type of template that you want to create today."
85
85
pyopensci
86
86
87
87
```
88
-
The template will then begin to copy files into the directory that used above. (`.` means current working directory
88
+
The template will then begin to copy files into the directory that used above. (`.` means current working directory.)
89
89
90
90
```console
91
91
...Copying from template version 0.6.4.1
@@ -112,10 +112,10 @@ The final package structure will look like this:
112
112
:animate: fade-in-slide-down
113
113
114
114
If you use the "bells and whistles" default option when working through the template prompts,
115
-
our template will create a complete package setup with GitHub CI actions, typing, tests, environments
116
-
, and more using Hatch. If you customize the entire package, then you can select what platform you wish to host it on (GitHub vs GitLab), whether you want typing, what documentation engine you want to use, and more.
115
+
our template will create a complete package setup with GitHub CI actions, typing, tests, environments,
116
+
and more using Hatch. If you customize the entire package, then you can select what platform you wish to host it on (GitHub vs GitLab), whether you want typing, what documentation engine you want to use, and more.
117
117
118
-
The resulting package directory looks like this
118
+
The resulting package directory looks like this:
119
119
120
120
```console
121
121
├── CHANGELOG.md
@@ -140,14 +140,14 @@ The resulting package directory looks like this
140
140
141
141
The default tools that your package uses are:
142
142
143
-
*[Sphinx](https://www.pyopensci.org/python-package-guide/documentation/hosting-tools/sphinx-python-package-documentation-tools.html) with the pydata_sphinx_theme for documentation
143
+
*[Sphinx](https://www.pyopensci.org/python-package-guide/documentation/hosting-tools/sphinx-python-package-documentation-tools.html) with the PyData Sphinx Theme for documentation
144
144
* pytest for testing
145
145
* Hatch for environment setup
146
146
147
147
**Full customization**
148
148
If you want to customize any elements of your package setup, choose `No, I want to fully customize the template.`. This will allow you to select:
149
149
150
-
*sphinx vs [mkdocs](https://www.mkdocs.org/) vs no documentation
150
+
*Sphinx vs [MkDocs](https://www.mkdocs.org/) vs no documentation
151
151
* GitHub vs GitLab
152
152
* VCS versioning
153
153
* and more
@@ -219,7 +219,7 @@ A `pyproject.toml` file stores metadata that provides instructions to various to
219
219
You will learn more about the `pyproject.toml` format in the
220
220
[next lesson when you add additional metadata/information to this file.](pyproject-toml.md)
221
221
222
-
The metadata in your generated pyproject.toml is already setup for you using the information you provided the copier template above.
222
+
The metadata in your generated `pyproject.toml` is already setup for you using the information you provided the copier template above.
223
223
224
224
:::{admonition} Brief overview of the TOML file
225
225
:class: tip
@@ -232,7 +232,7 @@ Tables can contain variables within them defined by a variable name and an `=` s
232
232
For instance, a `build-system` table most often holds two (2) variables:
233
233
234
234
1.`requires = `, which tells a build tool what tools it needs to install prior to building your package. In this case
235
-
[hatchling](https://pypi.org/project/hatchling/)
235
+
[hatchling](https://pypi.org/project/hatchling/).
236
236
2.`build-backend = `, which is used to define the specific build-backend name, (in this example we are using `hatchling.build`).
0 commit comments