File tree 1 file changed +21
-1
lines changed
1 file changed +21
-1
lines changed Original file line number Diff line number Diff line change @@ -3,7 +3,27 @@ title: Packaging
3
3
layout : default
4
4
---
5
5
6
- # Packaging
6
+ # General packaging
7
+
8
+ A common question facing developers is "_ How much code should go into a
9
+ package?_ ". Where code to solve a research problem might be large and perform
10
+ several tasks at once typically one should try to stick to a mantra of doing one
11
+ thing well.
12
+ The following questions can be helpful when trying to abide by this mantra:
13
+
14
+ - What do I want my package to provide?
15
+ - How will users interact with or use the code in my package?
16
+ - Is everything I'm including in the package relevant or useful in supporting it's main purpose?
17
+
18
+ In Python, a [ package] ( https://docs.python.org/3/reference/import.html#packages )
19
+ is a collection of one or more
20
+ [ modules] ( https://docs.python.org/3/glossary.html#term-module ) to perform
21
+ software tasks. Typically there is a separate git repository per package, and
22
+ we recommend you stick to this. You can always add the packages as dependencies
23
+ to a higher-level package which is effectively the same, but much easier to
24
+ reuse.
25
+
26
+ # Packaging tools
7
27
8
28
| Name | Short description | 🚦 |
9
29
| --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --- |
You can’t perform that action at this time.
0 commit comments