Skip to content

Commit 63b24fd

Browse files
aleafmnfienen
authored andcommitted
docs: update index.rst; add reference page on making python packages
1 parent f6cc68b commit 63b24fd

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,5 @@ We encourage students to explore these materials for their own study or to reach
2626
Additional links <SOME_HELPFUL_LINKS.md>
2727
Contributing <contributing>
2828
Glossary of jargon <glossary_of_jargon>
29-
Scientific coding best practices <best_practices>
29+
Making a Python package <packaging>
30+
Scientific programming best practices <best_practices>

docs/source/packaging.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Packaging: the next level
2+
3+
* Is your hard drive littered with miscellaneous scripts and
4+
Jupyter Notebooks that do similar things?
5+
* Are you copying and pasting the same code repeatedly?
6+
* Are you struggling to keep track of different versions of that
7+
code, or where you made the last change?
8+
* Are you sharing code over email or chat?
9+
10+
**If you answered yes to a few of these, you may need a package!**
11+
12+
With a package we can:
13+
* Collaborate on code in one place
14+
* Share, install and import any version into any script
15+
* Have confidence with automated tests; even as things change
16+
* Create and share nice looking documentation
17+
18+
Making a package needn’t be difficult, nor does it
19+
require “finished” code or formal publication. You can write
20+
packages for yourself or your internal colleagues! With
21+
cookiecutter templates, you can be up and running with a single
22+
code file in minutes and develop the package as you work on
23+
your project!
24+
25+
**Packaging Resources**
26+
27+
[Scientific Python Library Development Guide](https://learn.scientific-python.org/development/)
28+
29+
[Bootstrap a Scientific Python Library](https://nsls-ii.github.io/scientific-python-cookiecutter/)

0 commit comments

Comments
 (0)