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
@@ -6,7 +6,7 @@
6
6
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.
7
7
:::
8
8
9
-
(building-package)=
9
+
(build-package)=
10
10
## What is building a Python package?
11
11
12
12
To [publish your Python package](build_workflow) and make it easy for anyone to install, you first need to build it.
Copy file name to clipboardExpand all lines: tutorials/1-installable-code.md
+14-2Lines changed: 14 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -342,9 +342,14 @@ You are now ready to install (and build) your Python package!
342
342
Let’s try it out.
343
343
344
344
- 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.
346
346
- Finally run `python -m pip install -e .`
347
347
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
+
348
353
```bash
349
354
# Activate your environment using conda or venv
350
355
# 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.
471
476
472
477
In the upcoming lessons you will:
473
478
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!
474
486
* Add a [README file](2-add-readme.md) and [LICENSE](4-add-license-file.md) to your package
475
487
* [Add more metadata to your `pyproject.toml`](5-pyproject-toml.md) file to support PyPI publication.
476
488
* [Learn how to build your package distribution](6-publish-pypi.md) files (**sdist** and **wheel**) and publish to **test PyPI**.
477
489
* Finally you will learn how to publish to **conda-forge** from **PyPI**.
0 commit comments