Skip to content
Open
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
15 changes: 4 additions & 11 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ This guide will help you:
You will also find best practice recommendations and curated lists of community resources surrounding packaging and package documentation.
::::


```{todo}
TODO: change the navigation of docs to have a

Expand All @@ -56,11 +55,11 @@ Community docs

Publish your docs
```

## _new_ Tutorial Series: Create a Python Package

The first round of our community-developed, how to create a Python package tutorial series for scientists is complete! Join our community review process or watch development of future tutorials in our [GitHub repo here](https://github.com/pyOpenSci/python-package-guide).


:::::{grid} 1 1 2 2
:class-container: text-center
:gutter: 3
Expand Down Expand Up @@ -107,7 +106,6 @@ The first round of our community-developed, how to create a Python package tutor

:::::


## Python Packaging for Scientists

Learn about Python packaging best practices. You will also get to know the
Expand Down Expand Up @@ -195,7 +193,7 @@ Learn about best practices for:

## Tests

*We are actively working on this section. [Follow development here.](https://github.com/pyOpenSci/python-package-guide)*
_We are actively working on this section. [Follow development here.](https://github.com/pyOpenSci/python-package-guide)_

:::::{grid} 1 1 2 2
:class-container: text-center
Expand Down Expand Up @@ -227,7 +225,6 @@ Learn about best practices for:
:class-container: text-center
:gutter: 3


::::{grid-item}
:::{card} ✨ Code style & Format ✨
:class-card: left-aligned
Expand All @@ -249,8 +246,7 @@ contribute.

:::::


:::{figure} https://www.pyopensci.org/images/people-building-blocks.jpg
:::{figure} <https://www.pyopensci.org/images/people-building-blocks.jpg>
:align: right
:width: 350
:alt: xkcd comic showing a stick figure on the ground and one in the air. The one on the ground is saying. `You're flying! how?` The person in the air replies `Python!` Below is a 3 rectangle comic with the following text in each box. Box 1 - I learned it last night. Everything is so simple. Hello world is just print hello world. Box 2 - the person on the ground says - come join us programming is fun again. It's a whole new world. But how are you flying? box 3 - the person flying says - i just typed import antigravity. I also sampled everything in the medicine cabinet. But i think this is the python. The person on the ground is saying - that's it?
Expand Down Expand Up @@ -286,7 +282,6 @@ If you have questions about our peer review process or packaging in general, you

This living Python packaging guide 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
Expand All @@ -310,16 +305,14 @@ Documentation <documentation/index>

:::


:::{toctree}
:hidden:
:caption: Testing
:caption: Tests & Data

Tests <tests/index>

:::


:::{toctree}
:hidden:
:caption: Continuous Integration
Expand Down
11 changes: 9 additions & 2 deletions tests/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
(tests-intro)=

# Tests and data for your Python package

Tests are an important part of your Python package because they
Expand All @@ -9,7 +10,6 @@ In this section, you will learn more about the importance of writing
tests for your Python package and how you can set up infrastructure
to run your tests both locally and on GitHub.


:::::{grid} 1 1 3 2
:class-container: text-center
:gutter: 3
Expand Down Expand Up @@ -62,7 +62,6 @@ and different operating systems. Learn about setting up tests to run in Continuo

:::::


:::{figure-md} fig-target

<img src="../images/packaging-lifecycle.png" alt="" width="800px">
Expand All @@ -82,3 +81,11 @@ Run tests locally <run-tests>
Run tests online (using CI) <tests-ci>
Code coverage <code-cov>
```

```{toctree}
:hidden:
:maxdepth: 2
:caption: Data for Your Package

Package Data <package-data>
```
Loading
Loading