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
1. Individual files in your GitHub (or GitLab) repository including:
160
158
* [A clear and to the point **README.md** file](readme-file-best-practices) that includes information about how to cite your package.
@@ -176,16 +174,13 @@ alt: Image showing the files in the the MovingPandas GitHub repository. Files in
176
174
An example from the MovingPandas GitHub repository with all of the major files in it including CONTRIBUTING.md, README.md, CODE_OF_CONDUCT.md and a LICENSE.txt file. *(screen shot taken Nov 23 2022)*
177
175
```
178
176
179
-
180
-
181
177
## What's next in this Python package documentation section?
182
178
183
179
In this section of the pyOpenSci package guide, we will walk
184
180
you through best practices for setting up
185
181
documentation for your Python package. We will also suggest
186
182
tools that you can use to build your user-facing documentation website.
187
183
188
-
189
184
<!--
190
185
Commenting this out for now - it will be moved to another section
Copy file name to clipboardExpand all lines: index.md
-28
Original file line number
Diff line number
Diff line change
@@ -153,34 +153,6 @@ Good meets the requirements. Going beyond the minimum can make package maintenan
153
153
This guide is now a work in progress. If you have ideas of things you'd like
154
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
155
156
-
```{toctree}
157
-
:hidden:
158
-
:caption: Documentation
159
-
160
-
Documentation Overview <documentation/index>
161
-
Write User Documentation <documentation/write-user-documentation/intro>
Copy file name to clipboardExpand all lines: package-structure-code/intro.md
+47-1
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,52 @@ there are some great modern packaging tools that ensure that you're following
9
9
best practices. Here, we review tool features and suggest tools that might be
10
10
best fitted for your workflow.
11
11
12
+
::::{grid} 1 1 2 2
13
+
:class-container: text-center
14
+
:gutter: 3
15
+
16
+
:::{grid-item-card}
17
+
:link: python-package-build-tools
18
+
:link-type: doc
19
+
20
+
✨ Finding the right packaging tool(s) ✨
21
+
^^^
22
+
23
+
Learn more about the suite of packaging tools out there.
24
+
And learn which tool might be best for you.
25
+
:::
26
+
27
+
:::{grid-item-card}
28
+
:link: python-package-structure
29
+
:link-type: doc
30
+
31
+
✨ Package file structure ✨
32
+
^^^
33
+
src layout, flat layout and where should tests folders live? No matter what your level of packaging knowledge is, this page will help you decide upon a package structure that follows modern python best practices.
34
+
:::
35
+
36
+
:::{grid-item-card}
37
+
:link: python-package-build-tools
38
+
:link-type: doc
39
+
40
+
✨ Publish to PyPI and Conda ✨
41
+
^^^
42
+
If you have a pure python package, it's a straight forward
43
+
process to publish to both PyPI and then a Conda channel such as
44
+
conda-forge. Learn more here.
45
+
:::
46
+
47
+
:::{grid-item-card}
48
+
:link: code-style-linting-format
49
+
:link-type: doc
50
+
51
+
✨ Code style & linters ✨
52
+
^^^
53
+
Black, blue, flake8, Ruff - which tools can help you ensure your
54
+
package follows best practices for code format? Learn more about the options and why this is important here.
55
+
:::
56
+
::::
57
+
12
58
:::{figure-md} fig-target
13
59
14
60
<imgsrc="../images/python-package-tools-decision-tree.png"alt="Figure showing a decision tree with the various packaging tool front-end and back-end options."width="700px">
0 commit comments