You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Learn more about the importance of writing tests for your Python package and how you can setup infrastructure to run your tests both locally and on GitHub."
title: "Python packaging resources for scientists"
6
6
excerpt: "We make the scientific Python package ecosystem easier to navigate through peer review and packaging resources."
7
7
header:
8
8
overlay_image: images/header.jpg
9
9
overlay_filter: 0.8
10
10
intro:
11
-
- excerpt: "More here on community packaging."
12
-
scientists:
11
+
- excerpt: "There are many tools and approaches that can be used to create a Python package. We build resources that help you both understand the tool ecosystem and also learn how to create a Python package using modern best practices."
alt: "A pencil sketch of a round table with people from different backgrounds sitting around it, working on laptops and also writing together."
15
-
excerpt: "Our catalog of vetted open source tools makes it easier for scientists to find the trusted tools that they need to develop their open science workflows."
16
-
title: "Help scientists find the open science tools that they need"
btn_label: View our growing list of accepted scientific Python packages
15
+
excerpt: "We run an open peer review process for scientific Python software. Peer review helps maintainers improve the quality, usability and long-term maintainability of scientific software."
16
+
title: Raising the bar for scientific Python software"
btn_label: Learn more and get involved with peer review today.
19
19
btn_class: btn--primary
20
20
packaging-easier:
21
21
- image_path: images/people-building-blocks.jpg
22
22
alt: "A group of people working on a tetris like set of building blocks, trying to stack the blocks together. "
23
-
title: "Contribute to our packaging resources"
24
-
excerpt: "More about our review process, with links:
23
+
title: "Get Involved: Help us improve our scientific Python packaging resources"
24
+
excerpt: "
25
+
We need your help! Our packaging content is community-created and reviewed through an open review process on GitHub. The more feedback that we get, the more useful our resources are to the community. Get involved by:
25
26
26
-
* More
27
+
* Opening an issue about problems that you find in our guidebook
27
28
28
-
* More
29
+
* Submitting a pull request that fixes a typo or mistake in the guide.
30
+
31
+
* Get credit for your contribution
32
+
33
+
34
+
All contributions are recognized both on our website and in the guidebook's citation.
alt: "Diagram with a light purple background. On the left there is the pyOpenSci purple flower and it says accepted with a check mark above. There are two arrows leading to boxes on the right. The top box says JOSS published with a check next to it and the JOSS logo. The box below says Community Affiliated with a check. The boxes are numbered 1,2,3. "
36
-
excerpt: "
37
-
Through a single review process, community maintainers:
alt: "A group of people working on a tetris like set of building blocks, trying to stack the blocks together. "
42
+
title: "Community created Python Packaging Guide"
43
+
excerpt: "
44
+
Our packaging guide is a living document that will help you navigate the Python packaging ecosystem and also learn about modern Python packaging best practices.
45
+
46
+
* Created & curated by the community
38
47
39
-
* Have their package accepted into the pyOpenSci ecosystem
48
+
* Reviewed by beginner to expert level Pythonistas
40
49
41
-
* Can be [published in JOSS (if in scope)](https://www.pyopensci.org/software-peer-review/partners/joss.html#)
50
+
* Accurate, modern & beginner-friendly
42
51
43
-
* Can become an affiliated package with your community, following your community guidelines.
44
52
45
-
* Are supported in maintaining their tools, with input from our diverse, knowledgeable community, including active members from across the Python, Conda, PyPA and broader Python packaging ecosystem."
46
-
title: "Benefits of partnering with us"
53
+
All contributions are recognized both on our website and in the guidebook's citation.
54
+
"
47
55
toc: false
48
56
---
49
57
@@ -52,9 +60,9 @@ toc: false
52
60
<divclass="pyos-section purple">
53
61
<divclass="content"markdown="1">
54
62
55
-
## Check out our Python Packaging guidebook pages
63
+
{% include feature_row id="community-created" type="right" %}
56
64
57
-
They've been reviewed.. etc etc...
65
+
### Guidebook sections
58
66
59
67
<divclass="entries-grid">
60
68
{% for atutorial in site.packaging %}
@@ -64,8 +72,6 @@ They've been reviewed.. etc etc...
64
72
65
73
<divclass="clearfix"></div>
66
74
67
-
More here
68
-
69
75
</div>
70
76
</div>
71
77
@@ -74,9 +80,11 @@ More here
74
80
<divclass="pyos-section">
75
81
<divclass="content"markdown="1">
76
82
77
-
## Check out our Python Packaging tutorials
83
+
## Python packaging 101
78
84
79
-
We are currently developing a beginner-friendly packaging tutorial series.
85
+
Beginner-friendly Python packaging tutorials that will take you through
86
+
the full process of creating a Python package following modern best
87
+
practices.
80
88
81
89
<divclass="entries-grid">
82
90
{% for atutorial in site.tutorials %}
@@ -86,27 +94,7 @@ We are currently developing a beginner-friendly packaging tutorial series.
86
94
87
95
<divclass="clearfix"></div>
88
96
89
-
More here:
90
-
91
-
</div>
92
-
</div>
93
-
94
-
{% include div_purple_top.html %}
95
-
96
-
<divclass="pyos-section purple"markdown="1">
97
-
<divclass="content"markdown="1">
98
-
{% include feature_row id="scientists" type="left" %}
99
-
100
-
</div>
101
-
</div>
102
-
103
97
104
-
{% include div_purple_bottom.html %}
105
-
106
-
<divclass="pyos-section"markdown="1">
107
-
<divclass="content"markdown="1">
108
-
109
-
SDFSDF
110
98
111
99
</div>
112
100
</div>
@@ -115,31 +103,20 @@ SDFSDF
115
103
116
104
<divclass="pyos-section purple"markdown="1">
117
105
<divclass="content"markdown="1">
118
-
119
106
{% include feature_row id="packaging-easier" type="left" %}
120
107
121
108
</div>
122
109
</div>
123
110
124
-
{% include div_purple_bottom.html %}
125
111
126
-
<divclass="pyos-section"markdown="1">
127
-
<divclass="content"markdown="1">
128
-
{% include feature_row id="community" type="right" %}
129
-
</div>
130
-
</div>
112
+
{% include div_purple_bottom.html %}
131
113
132
114
<divclass="pyos-section"markdown="1">
133
115
<divclass="content"markdown="1">
134
-
## Raising the bar for Scientific Python software
135
116
117
+
{% include feature_row id="peer-review" type="right" %}
This lesson teaches you how to create the most basic version of a Python package. You will learn how to make your code installable into a Python environment."
0 commit comments