Skip to main content

Python API wrapper for the galician public transport

Project description

# bus.gal-api 🚍

[![GitHub license](https://img.shields.io/github/license/peprolinbot/bus.gal-api)](https://github.com/peprolinbot/bus.gal-api) [![PyPI version](https://img.shields.io/pypi/v/busGal-api?label=pypi%20package)](https://pypi.org/project/busGal-api) [![Upload Python Package](https://github.com/peprolinbot/bus.gal-api/actions/workflows/python-publish.yml/badge.svg)](https://github.com/peprolinbot/bus.gal-api/actions/workflows/python-publish.yml)

Python API wrapper for [the galician public transport](https://www.bus.gal/) which uses the associated [app](https://play.google.com/store/apps/details?id=gal.xunta.transportepublico)’s http API to get the inforamtion about buses, your card and your user account. I got the endpoints using [mitmproxy](https://mitmproxy.org/).

## 📜 Documentation

Documentation can be found [here](https://peprolinbot.github.io/bus.gal-api). There are two main submodules: busGal_api.transport and busGal_api.accounts, the first one has all the functions related to transportation and the second one allows you to manage cards and accounts, as the name implies.

## 🔧 Installation

Just run:

` bash pip install busGal_api `

## ✅ Quick examples

There are quick examples for both the submodules mentioned above in their __main__.py and their docs.

## ⚠️ Disclaimer

This project is not endorsed by, directly affiliated with, maintained by, sponsored by or in any way officially related with la Xunta de Galicia, the bus operators or any of the companies involved in the [bus.gal](https://www.bus.gal/) website and the [app](https://play.google.com/store/apps/details?id=gal.xunta.transportepublico).

This software is provided ‘as is’ without any warranty of any kind. The user of this software assumes all responsibility and risk for its use. I shall not be liable for any damages or misuse of this software. Please use the code and information in this repo responsibly.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

busgal_api-0.2.1.0.tar.gz (36.6 kB view details)

Uploaded Source

Built Distribution

busGal_api-0.2.1.0-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

Details for the file busgal_api-0.2.1.0.tar.gz.

File metadata

  • Download URL: busgal_api-0.2.1.0.tar.gz
  • Upload date:
  • Size: 36.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for busgal_api-0.2.1.0.tar.gz
Algorithm Hash digest
SHA256 444bc8fea5b7d16fbf6fbd552135936c9b3e2b1344a7e6c876875bf2ecce8b34
MD5 1a31ad657b64cf21af6b60eae5c34f6c
BLAKE2b-256 433021c20586d442d33074aec0a885dc8becae5ed5b840fb51baa4c5d9d01144

See more details on using hashes here.

File details

Details for the file busGal_api-0.2.1.0-py3-none-any.whl.

File metadata

  • Download URL: busGal_api-0.2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 41.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for busGal_api-0.2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f424e18528999681281b30357865dbf0938af9167bd7a99265425933a549efcd
MD5 b1acc5a36b16bd38d2f9131db0adcb4f
BLAKE2b-256 819fc03d4d75d2f3cd49a00c4a3dfe28819f97ac634c220a904b355887bada1f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page