Skip to content

chore(update): update two files #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonperron merged 1 commit into from
May 26, 2024
Merged

chore(update): update two files #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
name: release-dists
path: dist/

test-pypi-publish:
pypi-publish:
runs-on: ubuntu-latest
needs:
- release-build
Expand All @@ -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
22 changes: 10 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand All @@ -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.
Expand Down Expand Up @@ -70,11 +68,11 @@ datasets, pagination = client.datasets.list_datasets(region_id=<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

Expand Down