Skip to content

Commit f9f88b1

Browse files
committed
Add documentation for development
1 parent 0c30b9e commit f9f88b1

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

DEVELOPMENT.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# How to develop
2+
3+
## Requirement
4+
5+
- `python>=3.9`
6+
- `java`
7+
8+
## Setup
9+
10+
```bash
11+
pip install pipx
12+
pipx install poetry
13+
14+
poetry install
15+
poetry run pre-commit install
16+
```
17+
18+
## Activate virtual environment (venv) for development
19+
20+
```bash
21+
poetry shell
22+
```
23+
24+
## Lint
25+
26+
```bash
27+
# in venv:
28+
task lint
29+
```
30+
31+
## Fetch latest jar file and run tests
32+
33+
```bash
34+
# in venv:
35+
DOWNLOAD_LATEST_ONLY=1 python publish.py
36+
task test
37+
```
38+
39+
## Run tests for all unpublished versions without publishing
40+
41+
```bash
42+
# in venv:
43+
DRYRUN=1 python publish.py
44+
```
45+
46+
## Publish all unpublished versuibs to PyPI (for CI)
47+
48+
```bash
49+
# in venv:
50+
python publish.py
51+
```

0 commit comments

Comments
 (0)