Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vigonotion/pygti
access public transport information in hamburg, germany.
https://github.com/vigonotion/pygti
geofox gti hacktoberfest hvv
Last synced: about 2 months ago
JSON representation
access public transport information in hamburg, germany.
- Host: GitHub
- URL: https://github.com/vigonotion/pygti
- Owner: vigonotion
- License: apache-2.0
- Created: 2020-01-20T14:21:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T15:48:25.000Z (11 months ago)
- Last Synced: 2024-11-30T05:09:07.445Z (2 months ago)
- Topics: geofox, gti, hacktoberfest, hvv
- Language: Python
- Homepage:
- Size: 129 KB
- Stars: 11
- Watchers: 3
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
HVV Geofox Python Library
## About
This library is a python wrapper for accessing the geofox api. This api is used to get information about the public transport in Hamburg, Germany.
## How to get the api credentials
You have to apply for credentials via the HVV website. You can see their official guide [here](https://www.hvv.de/de/fahrplaene/abruf-fahrplaninfos/datenabruf) (the page is only available in German).
They will send you a contract you will have to sign and send back. After about a week, you will receive your api credentials.
## Documentation
This library uses the same data types and parameters as specified in the [GTI documentation](https://api-test.geofox.de/gti/doc/index.jsp). It features client side validation of the parameters.
## Installation
Install the [package from pypi](https://pypi.org/project/pygti/).
```python
pip install pygti
```
## Usage
See the examples on how to use the library at [examples.py](https://github.com/vigonotion/pygti/blob/master/examples.py), and see the [GTI documentation](https://api-test.geofox.de/gti/doc/index.jsp) for in-depth explanation of parameters.
There is also a [Glitch example](https://pygti-examples.glitch.me/) available. Try it out and if you want to see how it's done, just [remix the app](https://glitch.com/edit/#!/pygti-examples).
A minimal working example is shown below:
```python
from pygti.gti import GTI, Auth
import asyncio
import aiohttp
GTI_USER = "" # your api username
GTI_PASS = "" # your api password
async def main():
async with aiohttp.ClientSession() as session:
auth = Auth(session, GTI_USER, GTI_PASS)
gti = GTI(auth)
ir = await gti.init()
# see the examples.py file for more functionality and use of the payloads
asyncio.run(main())
```
> :exclamation: **If using Python 3.8**: Version 3.6.2 of aiohttp uses a different EventLoopPolicy so running this MWE will currently result in an error displayed in the console! It should not affect the functionality. This should be fixed with a newer version of aiohttp. For a workaround look into the [examples.py](https://github.com/vigonotion/pygti/blob/master/examples.py) file. For more information see this [Issue](https://github.com/aio-libs/aiohttp/issues/4324).
## Progress
- [x] 1. init
- [x] 2. checkName
- [x] 3. getRoute
- [x] 4. departureList
- [x] 5. getTariff
- [x] 6. departureCourse
- [x] 7. listStations
- [x] 8. listLines
- [x] 9. getAnnouncements
- [x] 10. getIndividualRoute
- [x] 11a. getVehicleMap
- [x] 11b. getTrackCoordinates
- [x] 12. checkPostalCode
- [x] 13. getStationInformation
- [x] 14. tariffZoneNeighbours
- [x] 15. tariffMetaData
- [x] 16. singleTicketOptimizer
- [x] 17. ticketList
## Developing
Some files in this project are generated based on the WADL and XSD schema files from GTI.
To generate them, install the dev dependencies and run the script:
```sh
pip install -r requirements_dev.txt
python script/generate.py
```
## Contributions are welcome!
If you want to contribute to this, please read the [Contribution guidelines](CONTRIBUTING.md)