Skip to content

Commit 456c495

Browse files
committed
Fix: a few minor edits
1 parent 769ca9f commit 456c495

File tree

3 files changed

+23
-9
lines changed

3 files changed

+23
-9
lines changed

index.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# pyOpenSci Python Open Source Package Development Guide
22

33

4-
54
```{toctree}
65
:hidden:
76
:caption: Documentation
@@ -30,7 +29,8 @@ https://github.com/pyOpenSci/python-package-guide/community -->
3029
## Welcome, Python open source enthusiast!
3130

3231
Here you will find guidelines for what we look for in your scientific
33-
Python package when reviewing. You will also find best practice recommendations and curated lists of community resources surrounding packaging and documentation.
32+
Python package when reviewing. You will also find best practice recommendations and curated lists of community resources surrounding packaging and documentation. Our goal is to help the
33+
community make decisions around how to create scientific Python packages. We are working towards a shared vision of packaging that helps users better understand where to start.
3434

3535
::::{grid} 2
3636
:reverse:
@@ -82,6 +82,16 @@ documentation that are
8282
commonly used in the scientific Python community.
8383
:::
8484

85+
:::{grid-item-card}
86+
:link: package-structure-code/intro
87+
:link-type: doc
88+
:class-header: bg-light
89+
90+
✨ Python packaging tools & structure ✨
91+
^^^
92+
All of the modern tools discussed in this guide will help you build an efficient packaging workflow. This section helps you select the one that will work best for your workflow.
93+
:::
94+
8595

8696
:::{grid-item-card}
8797
:link: CONTRIBUTING
@@ -98,9 +108,9 @@ contribute.
98108
## Who this guidebook is for
99109
We assume that you are here because you are:
100110

111+
1. Looking for guidance on creating a Python package.
112+
1. Looking for resources associated with Python packaging.
101113
1. Considering submitting a package to pyOpenSci and want to understand what we are looking for when we review your package
102-
2. Looking for guidance on creating a Python package.
103-
3. Looking for resources associated with Python packaging.
104114

105115
Well, friend, you've come to the right place!
106116

package-structure-code/intro.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
This section provides guidance on your Python package's structure, code formats and style. It also reviews the various packaging tools that you can use to
44
support building and publishing your package.
55

6+
If you are confused by Python packaging, you are not alone!
7+
The good news is there are some great modern packaging
8+
tools that ensure that you're following best practices. Here, we
9+
review tool features and suggest tools that might be best fitted for your workflow.
10+
11+
612
```{note}
713
If you are considering submitting a package for peer review, have a look at the
814
bare-minimum [editor checks](https://www.pyopensci.org/peer-review-guide/software-peer-review-guide/editor-in-chief-guide.html#editor-checklist-template) that pyOpenSci
@@ -55,7 +61,7 @@ The suggestions for package layout in this section are made with the
5561
intent of being helpful; they are not specific requirements for your
5662
package to be reviewed and accepted into our pyOpenSci open source ecosystem.
5763
58-
Please check out our [package scope page](https://www.pyopensci.org/software-peer-review/about/package-scope.html) and [review requirements in our author guide](https://www.pyopensci.org/software-peer-review/how-to/author-guide.html#) if you are looking for Python package review requirements!
64+
Please check out our [package scope page](https://www.pyopensci.org/software-peer-review/about/package-scope.html) and [review requirements in our author guide](https://www.pyopensci.org/software-peer-review/how-to/author-guide.html#) if you are looking for pyOpenSci's Python package review requirements!
5965
```
6066

6167
<!--

package-structure-code/python-package-structure.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ There are several core directories that should be included in all Python package
88
* **tests/** this directory contains the tests for your project code
99
* **package-name/**: this is the directory that contains the code for your Python project. It is normally named using your project's name.
1010

11-
Every Python package should have all 3 of the above directories within it.
1211

1312
## Src vs flat layouts
1413
There are two different layouts that you will commonly see
@@ -25,9 +24,8 @@ at the root of your package's repository.
2524

2625
On this page we:
2726

28-
1. Suggest the **src/package-name** layout structure for new packages. This layout prevents some commonly found issues with the flat layout (discussed below)
29-
2. Introduce the flat layout as it is used in the scientific ecosystem. Currently this layout is the most common. As such it's good to be familiar with it in case you contribute to a package using a flat layout in the future! Or, perhaps
30-
you maintain one now!
27+
1. Suggest the **src/package-name** layout structure for new packages. This layout prevents some commonly found issues with the flat layout (discussed below).
28+
2. Introduce the flat layout as it is used in the scientific ecosystem. Currently this layout is the most common. As such it's good to be familiar with it in case you contribute to a package using a flat layout in the future!
3129

3230
```{admonition} pyOpenSci will never require a specific package structure for peer review
3331
:class: important

0 commit comments

Comments
 (0)