diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index fd58736..0191e69 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -27,7 +27,7 @@ jobs: name: release-dists path: dist/ - test-pypi-publish: + pypi-publish: runs-on: ubuntu-latest needs: - release-build @@ -41,5 +41,5 @@ jobs: name: release-dists path: dist/ - - name: Publish package distributions to TestPyPI + - name: Publish package distributions to PyPI uses: pypa/gh-action-pypi-publish@release/v1 diff --git a/README.md b/README.md index 71d2cc8..9c799bb 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ This repository provides a unofficial Python wrapper to use [navitia.io APIs](ht To use this library, you will need an access token from [navitia.io](https://navitia.io/tarifs/). +##  Installation + +The package is available on PiPy + +```bash +pip install python-navitia-client +``` + ##  API support The library supports the following [APIs](https://doc.navitia.io/#api-catalog): @@ -31,16 +39,6 @@ The library supports the following [APIs](https://doc.navitia.io/#api-catalog): | Traffic reports | ✅ | Beta endpoint according to API response | | Equipment reports | ❌ | Beta service, not available to all providers | -##  Installation - -The package is not yet available on pip. - -For development purpose, you can install it using - -```bash -pip install -e . -``` - ## Usage To use this library, you need an authentication token provided by Navitia.io. @@ -70,11 +68,11 @@ datasets, pagination = client.datasets.list_datasets(region_id=) A couple of APIs are paginated, in particular the public transporations APIs.. In such case, you can navigate in the response using the parameters `start_page` and `count`. -An object `Pagination` will be provided by the impacted methods to help you navigatig. +An object `Pagination` will be provided by the impacted methods to help you navigating. ### Tips -Few tips on how to use the Navitia APIs are available [here](docs/few_tips.md) +Few tips on how to use the Navitia APIs are available [here](docs/few_tips.md). ##  Dependencies