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
This repo provides a template for biocommons Python packages. Here's how to use it:
6
8
7
9
1. Click the [Use this template](https://github.com/biocommons/example/generate)
@@ -11,28 +13,43 @@ This repo provides a template for biocommons Python packages. Here's how to use
11
13
1. Remove this header.
12
14
1. Commit and push.
13
15
16
+
Delete this section in your generated template.
17
+
18
+
---
19
+
14
20
## Installation
15
21
16
22
To install from pypi: ```pip install biocommons.example```
17
23
18
24
## Developer Setup
19
25
20
-
Developers must install zsh, which is required by the Makefile. zsh is included by default in MacOS, and is readily available on all modern Linux distributions.
26
+
### Prerequisites
21
27
22
-
Setup like this:
28
+
-[GNU make](https://www.gnu.org/software/make/): Current mechanism for consistent invocation of developer tools.
29
+
- Mac: [Install brew](https://brew.sh/), then [install make](https://formulae.brew.sh/formula/make)
30
+
- Ubuntu: `sudo apt install make`
31
+
-[uv](https://docs.astral.sh/uv/): An extremely fast Python package and project manager, written in Rust.
32
+
- All platforms: See the [uv installation instructions](https://docs.astral.sh/uv/getting-started/installation/).
33
+
-[zsh](https://www.zsh.org/): Shell used by the Makefile
34
+
- Mac: included by default
35
+
- Ubuntu: `sudo apt install zsh`
36
+
37
+
### One-time developer setup
38
+
39
+
Create a Python virtual environment and install dependencies:
23
40
24
41
make devready
42
+
43
+
### Development
44
+
45
+
Activate your environment:
46
+
25
47
source venv/bin/activate
26
48
27
49
Code reformatting:
28
50
29
51
make reformat
30
52
31
-
Install pre-commit hook:
32
-
33
-
# included in `make devready`, not necessary for new installations
34
-
pre-commit install
35
-
36
53
Test:
37
54
38
55
make test # for current environment
@@ -78,6 +95,3 @@ Try it:
78
95
* Quality tools: Code linting and reformatting with Ruff
0 commit comments