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
pyOpenSci is devoted to building diverse, supportive community around
12
+
the Python open source tools that drive open science. We do this through:
13
+
14
+
* open peer review
15
+
* mentorship and
16
+
* training.
17
+
18
+
pyOpenSci is an independent organization, fiscally sponsored by Community
19
+
Initiatives.
20
+
21
+
:construction: Construction note :construction:
22
+
23
+
This repository is currently under heavy construction. So please note that if
24
+
you are working through the content!
25
+
26
+
## Contributing statement
27
+
28
+
29
+
## How to setup
30
+
31
+
This repository contains the source files for the [pyOpenSci governance](https://pyopensci.org/governance).
32
+
33
+
## Build the governance document locally
34
+
35
+
Our governance documentation is built with [Sphinx](https://sphinx-doc.org) which is a documentation tool.
36
+
37
+
The easiest way to build our documentationis to use [the `nox` automation tool](https://nox.thea.codes/), a tool for quickly building environments and running commands within them.
38
+
Using `nox` ensures that your environment has all the dependencies needed to build the documentation.
39
+
40
+
To build, follow these steps:
41
+
42
+
1. Install `nox`
43
+
44
+
```console
45
+
$ pip install nox
46
+
```
47
+
2. Build the documentation:
48
+
49
+
```console
50
+
$ nox -s docs
51
+
```
52
+
53
+
This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/html`.
54
+
55
+
To build live documentation that updates when you update local files, run the following command:
56
+
57
+
```console
58
+
$ nox -s docs-live
59
+
```
60
+
61
+
62
+
## Contributing to this guide
63
+
64
+
We welcome and issues and pull-requests to improve the content of this guide.
65
+
If you'd like to see an improvement, please [open an issue](https://github.com/pyOpenSci/governance/issues/new/choose).
<!-- I think this is the end of the header - below begins the next grid-->
43
+
44
+
::::{grid} 1 1 1 2
45
+
:class-container: text-center
46
+
:gutter: 3
47
+
48
+
:::{grid-item-card}
49
+
:link: documentation/intro
50
+
:link-type: doc
51
+
:class-header: bg-light
52
+
53
+
✨ Documentation Criteria & Recommendations ✨
54
+
^^^
55
+
56
+
Learn about the good, better and best practices
57
+
associated with Python package documentation. Topics
58
+
covered include: README files, tutorials and full docs.
59
+
:::
60
+
61
+
:::{grid-item-card}
62
+
:link: code-style-structure/intro
63
+
:link-type: doc
64
+
:class-header: bg-light
65
+
66
+
✨Code style and structure✨
67
+
^^^
68
+
Get a basic overview of our open peer review process for Python scientific open source software.
69
+
:::
70
+
71
+
::::
72
+
73
+
74
+
### Python Packaging Guide for Maintainers Submitting to PyOpenSci
75
+
76
+
Welcome to pyOpenSci! We assume you are here because
77
+
78
+
1. you are considering submitting a package to pyOpenSci and want to understand the best practices that we suggest
79
+
2. You are looking for guidance on creating your first Python package.
80
+
3. Or you're just looking for resources associated with Python packaging.
81
+
82
+
Well, my friend you've come to the right place!
83
+
84
+
## What you will find in this guidebook
85
+
86
+
This guidebook contains:
87
+
88
+
* Explanation for "Good enough" minimum requirements associated with being reviewed by pyOpenSci
89
+
* Explanation of better and best practices in case you want to set the bar higher for your package (which we hope you will)!
90
+
* A curated list of resources to help you get your package into documented, usable and tested shape.
91
+
92
+
93
+
Most of the sections also include Good/Better/Best recommendations.
94
+
Good meets the requirements, but going beyond the minimum can make package maintenance easier-to-use for new users, easier-to contribute for new contributors and easier-to-maintain for you.
95
+
96
+
```{toctree}
97
+
:hidden:
98
+
:caption: Documentation
99
+
100
+
documentation/intro
101
+
documentation/readme-files
102
+
documentation/package-documentation-tutorials
103
+
```
104
+
105
+
```{toctree}
106
+
:hidden:
107
+
:caption: Code Style & Structure
108
+
109
+
code-style-structure/intro
110
+
```
111
+
112
+
```{toctree}
113
+
:hidden:
114
+
:caption: Test your code
115
+
116
+
testing-infrastructure/test-code
117
+
testing-infrastructure/continuous-integration
118
+
```
119
+
120
+
<!--
121
+
Removing button for the time being
122
+
```{button-ref} start/your-first-book
123
+
:ref-type: doc
124
+
:color: primary
125
+
:class: sd-rounded-pill float-left
126
+
Get Involved (Maybe a link to a get involved page)
0 commit comments