File: Development.md

package info (click to toggle)
python-pysnmp4 7.1.21-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 3,564 kB
  • sloc: python: 33,654; makefile: 166; javascript: 4
file content (62 lines) | stat: -rw-r--r-- 1,003 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
# Commands for Development

## Initialize Poetry

```bash
poetry init
poetry self add poetry-bumpversion
poetry add --group dev pre-commit=2.21.0
poetry run pre-commit install
```

## Change Poetry Venv Python Version

```bash
pyenv local 3.11
poetry env use 3.11
poetry env info --path
poetry env list
```

## Bump Version Number

1. Bump the version

   ```bash
   poetry lock
   poetry version patch
   ```

1. Edit `CHANGES.rst`

1. Edit `docs/poly.py` if the new version tag needs to be added to the list.

1. Modify nginx rule to route traffic to the latest version.

1. Update Roadmap in `ROADMAP.md`.

## Build Documentation

Build current version documentation to find and fix issues:

```bash
poetry run make html -C docs
```

Build multiple versions documentation for deployment:

```bash
poetry run sphinx-polyversion docs/poly.py
```

## Check Port number

```bash
netstat -anp udp | grep 1611
```

## Test Coverage

```bash
poetry run pytest --cov=pysnmp --cov-report=xml:coverage.xml
```