prepare release v3.0.0 (#7)

* update to macos

* re-arrange many things

* mainly readme; use setuptools_scm more extensively: github actions will see the tag and that package will automatically create a __version__.py:__version__ attribute with the correct, current version

* wrong manylinux image referernced

* trigger build

* trigger build again

* import decode_polyline to __init__.py

* trigger build

* pip not found?

* trigger build

* we're not in a container

* run pre-commit instead of plain commands

* trigger build

* needed special env var for cibuildwheel

* make paths absolute and remove static valhalla.json

* upload wheels as artifacts

* rename notebook; add some liens to readme

* remove the artifact from PRs

Author: nilsnolde

.github/workflows/publish_tags.yml

@@ -17,14 +17,14 @@ jobs:
         include:
           - image: ubuntu-latest
             platform: linux
-            cxx: 'g++-9'
           - image: windows-latest
             platform: windows
-            cxx: 'Visual Studio'
           - image: macos-latest
             platform: macos
     steps:
     - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
 
     - name: Configure Python
       uses: actions/setup-python@v2
@@ -56,7 +56,7 @@ jobs:
         conan install --install-folder conan_build --remote conancenter .
 
     - name: Install Conan (MacOS)
-      if: matrix.platform != 'windows' && steps.cache-conan.outputs.cache-hit != 'true'
+      if: matrix.platform == 'macos' && steps.cache-conan.outputs.cache-hit != 'true'
       run: |
         pip install pip --upgrade
         pip install conan

.github/workflows/pull_request.yml

@@ -15,39 +15,19 @@ on:
 jobs:
   build_wheels:
     name: PR - cp*, ubuntu-latest
-    container: ghcr.io/gis-ops/manylinux:valhalla_py
-
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
 
-    - name: Lint & Style Check
-      run: |
-        pip install black flake8
-        black --check valhalla
-        flake8 valhalla
-
-    # keep in-sync with the other yaml
-    # only macos makes sense, windows didn't work, linux installs conan inside the docker image
-    - name: Cache Conan
-      id: cache-conan
-      uses: actions/cache@v2
+    - name: Configure Python
+      uses: actions/setup-python@v2
       with:
-        path: |
-          ${{ github.workspace }}/conan_data
-          ${{ github.workspace }}/conan_build
-        key: conan-${{ matrix.platform }}-${{ hashFiles('conanfile.txt') }}
-        restore-keys: |
-          conan-${{ matrix.platform }}-
+        python-version: '3.7'
 
-    - name: Install Conan
-      if: steps.cache-conan.outputs.cache-hit != 'true'
+    - name: Lint & Style Check
       run: |
-        pip install pip --upgrade
-        pip install conan
-        conan profile new default --detect
-        conan config set "storage.path=${{ github.workspace }}/conan_data"
-        conan install --install-folder ${{ github.workspace }}/conan_build --remote conancenter .
+        pip install black flake8 pre-commit
+        pre-commit run --all-files --show-diff-on-failure
 
-    - name: Test
-      run: |
-        for py_version in cp37-cp37m cp38-cp38 cp39-cp39 cp310-cp310; do /opt/python/$py_version/bin/pip install -e . && /opt/python/$py_version/bin/python -c "from valhalla import Actor"; done
+    # only build the earliest supported python version
+    - uses: pypa/[email protected]

.github/workflows/push_master.yml

@@ -13,7 +13,7 @@ on:
 
 jobs:
   build_wheels:
-    name: Push - cp37*, ${{ matrix.image }}
+    name: Push - cp37*, ${{ matrix.platform }}
     runs-on: ${{ matrix.image }}
     strategy:
       fail-fast: true
@@ -44,7 +44,7 @@ jobs:
     - name: Cache Conan (MacOS)
       id: cache-conan
       uses: actions/cache@v2
-      if: matrix.platform != 'windows'
+      if: matrix.platform == 'macos'
       with:
         path: |
           ${{ github.workspace }}/conan_data
@@ -77,4 +77,4 @@ jobs:
     - uses: pypa/[email protected]
       env:
         MACOSX_DEPLOYMENT_TARGET: 10.9
-        CIBW_BUILD: 'cp37*'
+        CIBW_BUILD: cp37*

.gitignore

@@ -3,6 +3,9 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+# will be updated by setuptools_scm on github actions before releasing to pypi
+__version__.py
+
 # C extensions
 *.so
 

README.md

@@ -1,5 +1,5 @@
 # Valhalla for Python
-[![Master Push](https://github.com/gis-ops/valhalla-py/actions/workflows/push_master.yml/badge.svg)](https://github.com/gis-ops/valhalla-py/actions/workflows/push_master.yml)
+[![Master Push](https://github.com/gis-ops/pyvalhalla/actions/workflows/push_master.yml/badge.svg)](https://github.com/gis-ops/pyvalhalla/actions/workflows/push_master.yml)
 
 This spin-off project simply offers packaged Python bindings to the fantastic [Valhalla project](https://github.com/valhalla/valhalla).
 
@@ -11,9 +11,25 @@ We distribute all 4 currently supported CPython versions as binary **wheels** fo
 
 `pip install pyvalhalla`
 
+**Note**, to install from PyPI as a **Linux** user you must have `pip` version 20.3 or greater installed.
+
 ## Usage
 
-TODO
+Find a more extended notebook in `./examples`, e.g. how to [use the actor](./examples/actor_examples.ipynb).
+
+Before using the Python bindings you need to have access to a routable Valhalla graph. Either install Valhalla from source and built the graph from OSM compatible data or use our [Valhalla docker image](https://github.com/gis-ops/docker-valhalla) for a painless experience.
+
+Once you have created a graph locally, you can use it like this:
+```python
+from valhalla import Actor, get_config
+
+# generate configuration
+config = get_config(tile_extract='path/to/extract.tar', verbose=True)
+
+# instantiate Actor to load graph and call actions
+actor = Actor(config)
+route = actor.route({"locations": [...]})
+```
 
 ## License
 

docs/releasing.md

@@ -1,4 +1,4 @@
-## `valhalla-py` release patterns
+## `pyvalhalla` release patterns
 
 We release independently from Valhalla core. One can retrieve both by:
 
@@ -65,10 +65,10 @@ Proto headers have to be compiled on each platform separately.
 
 #### Linux
 
-Fire up the `ghcr.io/gis-ops/manylinux:valhalla_py` image which has all dependencies installed and build valhalla:
+Fire up the `ghcr.io/gis-ops/manylinux:valhalla_python` image which has all dependencies installed and build valhalla:
 
 ```
-docker run -dt -v $PWD:/valhalla-py --name valhalla-py ghcr.io/gis-ops/manylinux:valhalla_py
+docker run -dt -v $PWD:/valhalla-py --name valhalla-py ghcr.io/gis-ops/manylinux:valhalla_python
 ./scripts/build_linux.sh
 sudo chown -R nilsnolde:nilsnolde .
 ```
@@ -84,6 +84,14 @@ Pretty identical to Linux, just we don't need a docker container of course:
 ./scripts/build_mac.sh
 ```
 
+To test it worked:
+
+```
+pip uninstall pyvalhalla
+pip install wheelhouse/pyvalhalla-xxx.whl
+python -c "from valhalla import Actor; a = Actor('valhalla.json')"
+```
+
 #### Windows
 
 First build Valhalla:

examples/examples.ipynb examples/actor_examples.ipynbexamples/examples.ipynb renamed to examples/actor_examples.ipynb

@@ -8,6 +8,11 @@ requires = [
 ]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools_scm]
+write_to = "valhalla/__version__.py"
+write_to_template = "__version__ = '{version}'\n"
+version_scheme = "post-release"
+
 [tool.black]
 line-length = 105
 exclude = '''
@@ -22,7 +27,7 @@ exclude = '''
 '''
 
 [tool.cibuildwheel]
-test-command = "python -c \"from valhalla import Actor\""
+test-command = "python -m unittest discover -s {project}/test"
 # find out current defaults: cibuildwheel --print-build-identifiers --platform linux
 build = "cp*"
 skip = "*musllinux*"

pyproject.toml

@@ -37,7 +37,6 @@
     with conanfiles[0].open() as f:
         # it's just header-only boost so far..
         include_dirs.extend(json.load(f)["dependencies"][0]["include_paths"])
-
 else:
     logging.warning(
         "Conan not installed and/or no conan build detected. Assuming dependencies are installed."
@@ -70,11 +69,10 @@
     author_email="[email protected]",
     packages=find_packages(exclude=["tests", "*.tests", "*.tests.*", "tests.*"]),
     python_requires=">=3.7.0",
-    url="https://github.com/gis-ops/valhalla-py",
+    url="https://github.com/gis-ops/pyvalhalla",
     ext_package="valhalla",
     ext_modules=ext_modules,
     zip_safe=False,
-    use_scm_version=True,
     classifiers=[
         "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",
         "Programming Language :: Python :: 3",