File: CONTRIBUTING.md

package info (click to toggle)
harmonypy 0.0.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,092 kB
  • sloc: python: 393; makefile: 5
file content (65 lines) | stat: -rw-r--r-- 1,362 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
We use [hatch] to develop harmonypy.

Copy the harmonypy code to your computer:

```
git clone https://github.com/slowkow/harmonpy
```

Then change to the newly created directory:

```
cd harmonypy
```

Install hatch:

```
pipx install hatch
```

Create a new environment just for harmonypy:

```
hatch env create
```

Once we have hatch and an environment, then we can enter a new shell:

```
hatch shell
```

In this environment, we can run tests:

```
hatch test
```

And we can also build the files needed for PyPI:

```
hatch build
```

We should double-check that the contents of the `.tar.gz` file do not include any files we do not want to publish:

```
tar tvf dist/harmonypy-0.0.10.tar.gz
-rw-r--r--  0 0      0          97 Feb  1  2020 harmonypy-0.0.10/harmonypy/__init__.py
-rw-r--r--  0 0      0       12783 Feb  1  2020 harmonypy-0.0.10/harmonypy/harmony.py
-rw-r--r--  0 0      0        4559 Feb  1  2020 harmonypy-0.0.10/harmonypy/lisi.py
-rw-r--r--  0 0      0        1824 Feb  1  2020 harmonypy-0.0.10/.gitignore
-rw-r--r--  0 0      0       35149 Feb  1  2020 harmonypy-0.0.10/LICENSE
-rw-r--r--  0 0      0        3126 Feb  1  2020 harmonypy-0.0.10/README.md
-rw-r--r--  0 0      0        1026 Feb  1  2020 harmonypy-0.0.10/pyproject.toml
```

When we're ready, we can publish to PyPI:

```
hatch publish
```

[hatch]: https://hatch.pypa.io