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
Here you will find guidelines for what we look for in your scientific
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
32
+
Python package when reviewing. You will also find best practice recommendations and curated lists of community resources surrounding packaging and package documentation.
33
+
34
+
### pyOpenSci's packaging goals
35
+
36
+
Our goal is to help the
33
37
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.
34
38
39
+
### How this guide is created
40
+
41
+
This guide is created by pyOpenSci through an extensive review process. Each page in the guide has been reviewed by experts in the broader Python packaging landscape including people from :
42
+
43
+
- conda & conda-forge
44
+
- the python packaging authority
45
+
- core Python developers
46
+
- core scientific Python developers
47
+
- and others with expertise in packaging, package documentation, usability and other related knowledge areas
48
+
49
+
[View all of the people who have contributed to this guide here.
We use this guide as a foundation for our open peer review process of
53
+
scientific software.
54
+
35
55
::::{grid} 2
36
56
:reverse:
37
57
@@ -109,6 +129,13 @@ We assume that you are here because you are:
109
129
110
130
Well, friend, you've come to the right place!
111
131
132
+
:::{figure-md} fig-target
133
+
134
+
<imgsrc="/images/python-flying-xkcd.png"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?"width="400px">
135
+
136
+
Many love to use Python because it is a clean language to learn. It also is incredibly flexible allowing it to be used across numerous domains. Source: xkcd comics.
137
+
:::
138
+
112
139
## What you will find in this guidebook
113
140
114
141
This guidebook contains:
@@ -125,3 +152,63 @@ Good meets the requirements. Going beyond the minimum can make package maintenan
125
152
126
153
This guide is now a work in progress. If you have ideas of things you'd like
127
154
to see here, [we invite you to open an issue on GitHub that details any changes or additions that you'd like to see.](https://github.com/pyOpenSci/python-package-guide/issues).
155
+
156
+
```{toctree}
157
+
:hidden:
158
+
:caption: Documentation
159
+
160
+
Documentation Overview <documentation/index>
161
+
Write User Documentation <documentation/write-user-documentation/intro>
0 commit comments