Skip to content

Commit

Permalink
last little things before releasing
Browse files Browse the repository at this point in the history
  • Loading branch information
nilsnolde committed Mar 8, 2022
1 parent 747b73b commit 095d29f
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 7 deletions.
1 change: 0 additions & 1 deletion .github/workflows/publish_tags.yml
Expand Up @@ -86,4 +86,3 @@ jobs:
with:
user: nilsnolde
password: ${{ secrets.PYPI_PASS }}
repository_url: https://test.pypi.org/legacy/
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -3,11 +3,11 @@

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

Over time we will very likely deviate from Valhalla's own Python binding code to allow usages outside the scope of the core project.
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.

## Installation

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 enquiry@gis-ops.com if you need support building the bindings for your platform/distribution.
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 enquiry@gis-ops.com if you need support building the bindings for your platform/distribution.

`pip install pyvalhalla`

Expand Down
6 changes: 3 additions & 3 deletions docs/releasing.md
@@ -1,6 +1,6 @@
## `pyvalhalla` release patterns

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

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

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

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

#### Minor version change

Expand Down Expand Up @@ -75,7 +75,7 @@ sudo chown -R nilsnolde:nilsnolde .

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

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

#### Mac OS

Expand Down
1 change: 0 additions & 1 deletion valhalla/__init__.py
Expand Up @@ -3,5 +3,4 @@
from ._valhalla import *
from .__version__ import __version__

__version__ = __version__
__valhalla_commit__ = "b5ce7c418"

0 comments on commit 095d29f

Please sign in to comment.