Skip to content
This repository was archived by the owner on Oct 15, 2024. It is now read-only.

Commit 095d29f

Browse files
committed
last little things before releasing
1 parent 747b73b commit 095d29f

File tree

4 files changed

+5
-7
lines changed

4 files changed

+5
-7
lines changed

.github/workflows/publish_tags.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,3 @@ jobs:
8686
with:
8787
user: nilsnolde
8888
password: ${{ secrets.PYPI_PASS }}
89-
repository_url: https://test.pypi.org/legacy/

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33

44
This spin-off project simply offers packaged Python bindings to the fantastic [Valhalla project](https://github.com/valhalla/valhalla).
55

6-
Over time we will very likely deviate from Valhalla's own Python binding code to allow usages outside the scope of the core project.
6+
Over time we will very likely deviate from Valhalla's own Python binding code to allow usages outside the scope of the core project. Refer to our [release pattern](./docs/releasing.md) to learn more about the versioning of this project.
77

88
## Installation
99

10-
We distribute all 4 currently supported CPython versions as binary **wheels** for Win64, MacOS (Intel) and x86_64 Linux distributions with `glibc>=2.24` (most modern systems, see [PEP 600](https://www.python.org/dev/peps/pep-0600/)). We **do not** offer a source distribution on PyPI. Please contact us on [email protected] if you need support building the bindings for your platform/distribution.
10+
We distribute all 4 currently developed CPython versions as **binary wheels** for Win64, MacOS (Intel) and x86_64 Linux distributions with `glibc>=2.24` (most modern systems, see [PEP 600](https://www.python.org/dev/peps/pep-0600/)). We **do not** offer a source distribution on PyPI. Please contact us on [email protected] if you need support building the bindings for your platform/distribution.
1111

1212
`pip install pyvalhalla`
1313

docs/releasing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## `pyvalhalla` release patterns
22

3-
We release independently from Valhalla core. One can retrieve both by:
3+
We release independently of Valhalla core but adhere to its major version. One can retrieve both by:
44

55
```python
66
import valhalla
@@ -16,7 +16,7 @@ We follow semantic versioning as good as we can with the following guarantees:
1616

1717
Reflects Valhalla's major version, i.e. we can guarantee compatibility of tiles built by the same Valhalla major version.
1818

19-
As opposed to Valhalla itself, we also guarantee API stability (much easier to do in bindings).
19+
Because of that you can't expect full API stability, though we do our best.
2020

2121
#### Minor version change
2222

@@ -75,7 +75,7 @@ sudo chown -R nilsnolde:nilsnolde .
7575

7676
That'll take care of all the header & library copying, proto compilation etc. It'll also build a wheel to `./wheelhouse`.
7777

78-
- **add the built valhalla commit and add the current version in __init__.py**
78+
- **add the built valhalla commit in __init__.py**
7979

8080
#### Mac OS
8181

valhalla/__init__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,4 @@
33
from ._valhalla import *
44
from .__version__ import __version__
55

6-
__version__ = __version__
76
__valhalla_commit__ = "b5ce7c418"

0 commit comments

Comments
 (0)