Skip to content

[review-round-2 - Jan 3 merge] What is a Python package intro tutorial? #139

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 29 commits into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
0852247
Add: initial new tutorial and images
lwasser Nov 30, 2023
0eecf5e
Fix: edits from code review
lwasser Dec 22, 2023
c25d728
Fix: local cleanup of commented things
lwasser Dec 22, 2023
96f9120
Fix: edits from @kierski
lwasser Dec 22, 2023
3323538
Fix: edits from @kierski
lwasser Dec 22, 2023
88898db
Update tutorials/intro.md
lwasser Dec 22, 2023
2374225
Apply suggestions from code review
lwasser Dec 22, 2023
07d5778
Edits from @nickledave
lwasser Dec 22, 2023
cde9837
Fix: more edits from the review
lwasser Dec 22, 2023
787befc
Fix: added ticket trackers @ucodery review
lwasser Dec 22, 2023
899d986
Fix: feedback from @nickledave and @billbrod
lwasser Dec 22, 2023
6057b53
Fix: rest of the review comments addressed
lwasser Dec 22, 2023
090cb22
Fix: alt tags and spelling
lwasser Dec 22, 2023
befd0e2
Edits from Inessa
lwasser Dec 22, 2023
503afa1
Update bookmarks
lwasser Dec 22, 2023
58243a0
Update index.md
lwasser Dec 27, 2023
8cac479
Fix: edits from @ucodery
lwasser Dec 27, 2023
16ae1cd
Fix: edit from @billbrod
lwasser Jan 3, 2024
a0784bc
Update tutorials/intro.md
lwasser Jan 3, 2024
ec0ebfc
Final edits from review
lwasser Jan 3, 2024
e94ba74
Enh: Redesign of packaging guide landing page (#140)
lwasser Dec 28, 2023
7088791
Fix: edits from first pr applied
lwasser Dec 20, 2023
2b66fd9
Fix: rename section for shorter url
lwasser Dec 20, 2023
e436350
Fix: missing image
lwasser Dec 20, 2023
c023c6c
Fix: remove unpublished content links
lwasser Dec 20, 2023
95f79f9
Merge branch 'main' into bb-dec23-intro-2
lwasser Jan 3, 2024
57e5cf0
Fix: add tutorials to landing page
lwasser Jan 3, 2024
804a852
Fix: broken links
lwasser Jan 3, 2024
19dc258
Fix: 3 more broken links- created todos for when new links are live
lwasser Jan 3, 2024
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ tmp/
__pycache__
*notes-from-review.md
*.idea*

.vale.ini
styles/*
7 changes: 0 additions & 7 deletions ci-and-testing/intro.md

This file was deleted.

Binary file added images/tutorials/environment-package-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/tutorials/package-components.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/tutorials/packaging-101-outline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/tutorials/packaging-lifecycle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/tutorials/publish-package-pypi-conda.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/tutorials/toolbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,28 @@ Community docs

Publish your docs
```
## _new_ Tutorial series - how to create a Python package

The how to create a Python package tutorial series is being developed
by the community now! Join our community review process or watch development of these tutorials in our [Github repo here](https://github.com/pyOpenSci/python-package-guide).


:::::{grid} 1 1 2 2
:class-container: text-center
:gutter: 3

::::{grid-item}

:::{card} ✿ Tutorials ✿
:class-card: left-aligned

[What is a Python package?](/tutorials/intro)

:::
::::

:::::


## Python packaging ecosystem overview & best practices

Expand Down Expand Up @@ -166,6 +188,13 @@ 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: Testing

Tutorials <tutorials/intro>

```

```{toctree}
:hidden:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ or is more complex in its build, the two distributions will be very different.
Also note that we are not discussing conda build workflows in this section.
[You can learn more about conda builds here.](https://conda.io/projects/conda-build/en/latest/user-guide/tutorials/index.html)
```

(python-source-distribution)=
## Source Distribution (sdist)

Expand Down
338 changes: 338 additions & 0 deletions tutorials/intro.md

Large diffs are not rendered by default.