# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/peprolinbot/bus.gal-api",
"name": "busGal-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "bus, buses, transport, public transport, galicia, api",
"author": "Pedro Rey Anca",
"author_email": "contact@peprolinbot.com",
"download_url": "https://files.pythonhosted.org/packages/dd/55/3d13d163dd4a63c89156aa2b653918f9099184189e8040ef559afe1ea6fe/busgal_api-0.2.2.1.tar.gz",
"platform": null,
"description": "# bus.gal-api \ud83d\ude8d\n\n[![GitHub license](https://img.shields.io/github/license/peprolinbot/bus.gal-api)](https://github.com/peprolinbot/bus.gal-api)\n[![PyPI version](https://img.shields.io/pypi/v/busGal-api?label=pypi%20package)](https://pypi.org/project/busGal-api)\n[![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)\n\nPython API wrapper for [the galician public transport](https://www.bus.gal/) which uses the\nassociated\n[app](https://play.google.com/store/apps/details?id=gal.xunta.transportepublico)'s\nhttp API to get the inforamtion about buses, your card and your user\naccount. I got the endpoints using [mitmproxy](https://mitmproxy.org/).\n\n## \ud83d\udcdc Documentation\n\nDocumentation 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.\n\n## \ud83d\udd27 Installation\n\nJust run:\n\n``` bash\npip install busGal_api\n```\n\n## \u2705 Quick examples\n\nThere are quick examples for both the submodules mentioned above in their `__main__.py` and their docs.\n\n## \u26a0\ufe0f Disclaimer\n\nThis project is not endorsed by, directly affiliated with, maintained\nby, sponsored by or in any way officially related with la Xunta de\nGalicia, the bus operators or any of the companies involved in the\n[bus.gal](https://www.bus.gal/) website and the\n[app](https://play.google.com/store/apps/details?id=gal.xunta.transportepublico).\n\nThis 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.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python API wrapper for the galician public transport",
"version": "0.2.2.1",
"project_urls": {
"Bug Tracker": "https://github.com/peprolinbot/bus.gal-api/issues",
"Documentation": "https://peprolinbot.github.io/bus.gal-api",
"Homepage": "https://github.com/peprolinbot/bus.gal-api"
},
"split_keywords": [
"bus",
" buses",
" transport",
" public transport",
" galicia",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f3d81ef0452b2b408f20082af91c442dbf877dfb50cf120d4987d0d892396bd1",
"md5": "e9580538e6bfba9a001487c72bd4520f",
"sha256": "7d4d62f2ce82812c2851f1890ffd617db4063c365e9b9a2aedec867a02ef1dc3"
},
"downloads": -1,
"filename": "busGal_api-0.2.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9580538e6bfba9a001487c72bd4520f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 41639,
"upload_time": "2024-10-13T22:31:29",
"upload_time_iso_8601": "2024-10-13T22:31:29.557534Z",
"url": "https://files.pythonhosted.org/packages/f3/d8/1ef0452b2b408f20082af91c442dbf877dfb50cf120d4987d0d892396bd1/busGal_api-0.2.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dd553d13d163dd4a63c89156aa2b653918f9099184189e8040ef559afe1ea6fe",
"md5": "11348ff6e3753eb9f934ccf288fefae7",
"sha256": "b503f207707ca95d7de66c8cb04abb1b0cce378f5350d309fe54ab1dbd0002f5"
},
"downloads": -1,
"filename": "busgal_api-0.2.2.1.tar.gz",
"has_sig": false,
"md5_digest": "11348ff6e3753eb9f934ccf288fefae7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 36692,
"upload_time": "2024-10-13T22:31:30",
"upload_time_iso_8601": "2024-10-13T22:31:30.998858Z",
"url": "https://files.pythonhosted.org/packages/dd/55/3d13d163dd4a63c89156aa2b653918f9099184189e8040ef559afe1ea6fe/busgal_api-0.2.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-13 22:31:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "peprolinbot",
"github_project": "bus.gal-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "busgal-api"
}