Skip to content

ENH: Tutorial - Python Packaging - How to make your code installable #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Jan 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/artifact_redirect.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: CircleCI artifacts redirector
name: Book Preview Redirect
on: [status]

concurrency:
Expand Down
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ tmp/
__pycache__
*notes-from-review.md
*.idea*

# Grammar / syntax checkers
.vale.ini
styles/*
styles/
Binary file added images/tutorials/code-to-python-package.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 7 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,12 @@ by the community now! Join our community review process or watch development of
:class-card: left-aligned

* [What is a Python package?](/tutorials/intro)
* How to make your code installable (coming next!)
* [Make your code installable](/tutorials/1-installable-code)
* *How to add a README and LICENSE to support publication (coming next!)*
* *How to add metadata to a pyproject.toml file for publication to PyPI.*

_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_

_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_

:::
::::
Expand Down Expand Up @@ -201,14 +204,14 @@ If you have questions about our peer review process or packaging in general, you

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.


```{toctree}
:hidden:
:caption: Tutorials

Tutorials <tutorials/intro>

```


```{toctree}
:hidden:
:caption: Documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
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.
:::

(build-package)=
## What is building a Python package?

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