@@ -28,12 +28,6 @@ understanding the steps involved in creating a Python package.
28
28
:caption: Python Packaging 101
29
29
30
30
What is a Python package? <self >
31
- Make your code pip installable <1-installable-code>
32
- Add README file <2-add-readme>
33
- Add LICENSE & CODE of CONDUCT <4-add-license-file>
34
- Add pyproject.toml <5-pyproject-toml>
35
- Publish to PyPI <6-publish-pypi>
36
- Publish to conda-forge <7-publish-conda-forge>
37
31
:::
38
32
39
33
:::{admonition} Learning Objectives
@@ -262,7 +256,7 @@ for clean code in future pyOpenSci tutorials.
262
256
263
257
** Readable code:** readable code is code written with a consistent style.
264
258
You can use linters and code formatters such as black and flake8 to ensure
265
- this consistency throughout your entire package. [ Learn more about code formatters here.] ( ../package-structure-code/code-style-linting-format.html )
259
+ this consistency throughout your entire package. [ Learn more about code formatters here.] ( ../package-structure-code/code-style-linting-format )
266
260
267
261
** Documented code:** documented code is written using docstrings that help a
268
262
user understand both what the functions and methods in your code do and also
@@ -295,9 +289,10 @@ publish it in a repository such as **PyPI** or **conda-forge**.
295
289
296
290
:::{todo}
297
291
The links below won't work until those lessons (which are written) are published.
298
- :::
299
292
300
293
Learn [ how to publish your package to PyPI in this tutorial.] ( 6-publish-pypi.md )
294
+ :::
295
+
301
296
302
297
:::{todo}
303
298
This lesson is also not published - yet but will be reviewed soon.
0 commit comments