Skip to content

Commit 0673901

Browse files
authored
ENH: Tutorial - Python Packaging - How to make your code installable
Second tutorial going live today!!
2 parents 857f4c6 + 3150b12 commit 0673901

File tree

7 files changed

+515
-7
lines changed

7 files changed

+515
-7
lines changed

.github/workflows/artifact_redirect.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: CircleCI artifacts redirector
1+
name: Book Preview Redirect
22
on: [status]
33

44
concurrency:

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ tmp/
77
__pycache__
88
*notes-from-review.md
99
*.idea*
10-
10+
# Grammar / syntax checkers
1111
.vale.ini
12-
styles/*
12+
styles/
23.5 KB
Loading

index.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,12 @@ by the community now! Join our community review process or watch development of
7272
:class-card: left-aligned
7373

7474
* [What is a Python package?](/tutorials/intro)
75-
* How to make your code installable (coming next!)
75+
* [Make your code installable](/tutorials/1-installable-code)
76+
* *How to add a README and LICENSE to support publication (coming next!)*
77+
* *How to add metadata to a pyproject.toml file for publication to PyPI.*
78+
79+
_The third lesson is currently under review in our [GitHub Repo here](https://github.com/pyOpenSci/python-package-guide/pulls). It will be live by the end of Feb 2024_
7680

77-
_The second lesson is currently under review in our [GitHub Repo here](https://github.com/pyOpenSci/python-package-guide/pulls). It will be live by the end of January 2024_
7881

7982
:::
8083
::::
@@ -201,14 +204,14 @@ If you have questions about our peer review process or packaging in general, you
201204

202205
This is a living guide that is updated as tools and best practices evolve in the Python packaging ecosystem. We will be adding new content over the next year.
203206

207+
204208
```{toctree}
205209
:hidden:
206210
:caption: Tutorials
207-
208211
Tutorials <tutorials/intro>
209-
210212
```
211213

214+
212215
```{toctree}
213216
:hidden:
214217
:caption: Documentation

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +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+
(build-package)=
910
## What is building a Python package?
1011

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

0 commit comments

Comments
 (0)