Skip to content

Commit 6146e7e

Browse files
committed
Fix: links in todos to be published once all lessons are live
1 parent fa5a6ac commit 6146e7e

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

package-structure-code/python-package-distribution-files-sdist-wheel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
You need to build your Python package in order to publish it to PyPI (or Conda). The build process organizes your code and metadata into a distribution format that can be uploaded to PyPI and subsequently downloaded and installed by users. NOTE: you need to publish a sdist to PyPI in order for conda-forge to properly build your package automatically.
77
:::
88

9-
(building-package)=
9+
(build-package)=
1010
## What is building a Python package?
1111

1212
To [publish your Python package](build_workflow) and make it easy for anyone to install, you first need to build it.

tutorials/1-installable-code.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -342,9 +342,14 @@ You are now ready to install (and build) your Python package!
342342
Let’s try it out.
343343

344344
- First open your preferred shell (Windows users may be using something like gitbash) and `cd` into your project directory
345-
- Activate the Python environment that you wish to use. If you need help with working with virtual environments [check out this lesson](extras/1-create-environment.md).
345+
- Activate the Python environment that you wish to use.
346346
- Finally run `python -m pip install -e .`
347347

348+
:::{todo}
349+
Add this back in when the lesson is published
350+
- Activate the Python environment that you wish to use. If you need help with working with virtual environments [check out this lesson](extras/1-create-environment.md).
351+
:::
352+
348353
```bash
349354
# Activate your environment using conda or venv
350355
# Below we use conda but you can do the same thing with venv!
@@ -471,11 +476,18 @@ to publish your package, you have completed the first major step.
471476
472477
In the upcoming lessons you will:
473478
479+
* Add a README file and LICENSE to your package
480+
* Add more metadata to your `pyproject.toml` file to support PyPI publication.
481+
* Learn how to build your package distribution files (**sdist** and **wheel**) and publish to **test PyPI**.
482+
* Finally you will learn how to publish to **conda-forge** from **PyPI**.
483+
484+
:::{todo}
485+
This is the content with links once the links are live we can uncomment this and remove the unlinked content above!
474486
* Add a [README file](2-add-readme.md) and [LICENSE](4-add-license-file.md) to your package
475487
* [Add more metadata to your `pyproject.toml`](5-pyproject-toml.md) file to support PyPI publication.
476488
* [Learn how to build your package distribution](6-publish-pypi.md) files (**sdist** and **wheel**) and publish to **test PyPI**.
477489
* Finally you will learn how to publish to **conda-forge** from **PyPI**.
478-
490+
:::
479491
480492
## Footnotes
481493

0 commit comments

Comments
 (0)