pygti 0.9.4

access public transport information in hamburg, germany.

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 (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. It features client side validation of the parameters.

Installation

Install the package from pypi.

pip install pygti

Usage

See the examples on how to use the library at examples.py, and see the GTI documentation for in-depth explanation of parameters.

There is also a Glitch example available. Try it out and if you want to see how it's done, just remix the app.

A minimal working example is shown below:

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 file. For more information see this Issue.

Progress

• 1. init
• 2. checkName
• 3. getRoute
• 4. departureList
• 5. getTariff
• 6. departureCourse
• 7. listStations
• 8. listLines
• 9. getAnnouncements
• 10. getIndividualRoute
• 11a. getVehicleMap
• 11b. getTrackCoordinates
• 12. checkPostalCode
• 13. getStationInformation
• 14. tariffZoneNeighbours
• 15. tariffMetaData
• 16. singleTicketOptimizer
• 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:

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