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 workflow will upload a Python Package using Twine when a release is created
2
-
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
3
-
4
-
# This workflow uses actions that are not certified by GitHub.
5
-
# They are provided by a third-party and are governed by
6
-
# separate terms of service, privacy policy, and support
7
-
# documentation.
1
+
# This workflow builds and publishes the package when a release is created.
8
2
9
3
name: Upload Python Package
10
4
@@ -20,14 +14,34 @@ jobs:
20
14
name: upload release to PyPI
21
15
runs-on: ubuntu-latest
22
16
permissions:
23
-
# This permission is needed for private repositories.
24
17
contents: read
25
-
# IMPORTANT: this permission is mandatory for trusted publishing
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-9Lines changed: 16 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,39 +13,46 @@ For more information on contributing to open source projects, [GitHub's own guid
13
13
14
14
## Setting up your development environment
15
15
16
-
To get started, fork the `landmarker` repository and clone it to your local machine. Then, install the required dependencies using <ahref="https://pdm.fming.dev/"target="_blank">pdm</a> (see <ahref="https://pdm-project.org/latest/#installation"target="_blank">installation instructions</a>):
16
+
To get started, fork the `landmarker` repository and clone it to your local machine. Then, install the required dependencies using <ahref="https://docs.astral.sh/uv/"target="_blank">uv</a> (see <ahref="https://docs.astral.sh/uv/getting-started/installation/"target="_blank">installation instructions</a>):
17
17
18
18
```bash
19
-
pdm install --dev
19
+
uv sync
20
20
```
21
21
22
22
## Running tests
23
-
`landmarker` uses [pytest](https://docs.pytest.org/en/stable/) for testing. You can run test by running a pdm script, by using the following command:
23
+
`landmarker` uses [pytest](https://docs.pytest.org/en/stable/) for testing. Coverage reporting is enabled by default:
24
24
25
25
```bash
26
-
pdm run test
26
+
uv run pytest
27
27
```
28
28
29
-
If you want to run pytest with coverage, you can use the following command:
29
+
To run the complete test matrix across all supported Python versions, as well as the lint and type-check environments, use tox:
30
30
31
31
```bash
32
-
pdm run coverage
32
+
uv run tox
33
+
```
34
+
35
+
You can also run the lint and type checks directly:
36
+
37
+
```bash
38
+
uv run flake8 src/
39
+
uv run mypy src/
33
40
```
34
41
35
42
## Building documentation
36
43
`landmarker` uses [sphinx](https://www.sphinx-doc.org/en/master/) for documentation, and use MyST markdown for documentation pages. You can build the documentation locally by running the following command:
37
44
38
45
```bash
39
-
pdm run doc
46
+
uv run sphinx-build docs docs/_build/html
40
47
```
41
48
42
49
We also support the use of [sphinx-autobuild](https://github.com/executablebooks/sphinx-autobuild), which will automatically rebuild the documentation when a change is detected and live-reload the page in your browser. You can run it using the following command:
43
50
44
51
```bash
45
-
pdm run docauto
52
+
uv run sphinx-autobuild docs docs/_build/html --ignore _collections
46
53
```
47
54
48
55
## Ground Rules
49
56
The goal is to maintain a diverse community that's pleasant for everyone.
50
57
**Please be considerate and respectful of others**.
51
-
Everyone must abide by our [Code of Conduct](https://github.com/GenericMappingTools/.github/blob/main/CODE_OF_CONDUCT.md) and we encourage all to read it carefully.
58
+
Everyone must abide by our [Code of Conduct](https://github.com/GenericMappingTools/.github/blob/main/CODE_OF_CONDUCT.md) and we encourage all to read it carefully.
0 commit comments