jlt-bus-schedule 1.0.0__tar.gz

jlt_bus_schedule-1.0.0/.gitignore

@@ -0,0 +1,211 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Jetbrains
+.idea/
+/uv.lock

jlt_bus_schedule-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jonny Bergdahl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

jlt_bus_schedule-1.0.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.5
+Name: jlt-bus-schedule
+Version: 1.0.0
+Summary: Async client that scrapes bus departures and stops from JLT (Jönköpings Länstrafik)
+Project-URL: Homepage, https://github.com/jonnybergdahl/Python-JLT-BusSchedule-Scraper
+Project-URL: Issues, https://github.com/jonnybergdahl/Python-JLT-BusSchedule-Scraper/issues
+Author: Jonny Bergdahl
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bus,home assistant,jlt,jönköping,public transport
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: tzdata; sys_platform == 'win32'
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=0.24; extra == 'test'
+Requires-Dist: pytest>=8; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Python-JLT-BusSchedule-Scraper
+Python library that scrapes the JLT site for bus schedules. 
+
+[JLT (Jönköpings Länstrafik)](https://www.jlt.se) has no public API for departures, so this
+library scrapes the HTML fragment used by the departure board on jlt.se, and the stop search
+of the travel planner that jlt.se embeds from etiscloud.net.
+
+It is used by the [JLT Bus Schedule](https://github.com/jonnybergdahl/HomeAssistant_JltBusSchedule_Integration)
+Home Assistant integration.
+
+## Installation
+
+```bash
+pip install jlt-bus-schedule
+```
+
+Requires Python 3.11 or later.
+
+## Usage
+
+```python
+import asyncio
+
+from jlt_bus_schedule import JltApiClient
+
+
+async def main() -> None:
+    async with JltApiClient() as client:
+        stops = await client.async_search_stops("Rådhusparken")
+        stop = stops[0]
+        print(f"{stop.name} ({stop.id})")
+
+        for departure in await client.async_get_departures(stop.id, take=10):
+            print(
+                f"{departure.departure_time} {departure.line:>3} "
+                f"{departure.destination} ({departure.time_to_departure})"
+            )
+
+
+asyncio.run(main())
+```
+
+```
+Jönköping Rådhusparken (6001320)
+13:20   3 Råslätt via Asecs-Ryhov (Avgår nu)
+13:21 141 Sävsjö via Vrigstad (Avgår nu)
+13:22   4 Huskvarna via Solåsen-Ryhov (Avgår om 1 min)
+...
+```
+
+### Sharing an aiohttp session
+
+Pass an existing `aiohttp.ClientSession` to share it with the rest of your application, as
+Home Assistant integrations should. The client never closes a session it did not create.
+
+```python
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+
+client = JltApiClient(async_get_clientsession(hass))
+```
+
+Without a session the client creates its own, which is closed by `await client.close()` or when
+leaving an `async with` block.
+
+A custom `User-Agent` header can be set with `JltApiClient(session, user_agent="MyApp/1.0")`.
+
+## API
+
+### `JltApiClient`
+
+| Method | Description |
+|--------|-------------|
+| `async_get_departures(stop_id, take=20, timeout=10)` | Upcoming departures for all lines at a stop, as a list of `Departure`. Departures that have already left are skipped. |
+| `async_search_stops(query, timeout=10)` | Stops matching a name, best match first, as a list of `Stop`. |
+| `close()` | Close the session, if it was created by the client. |
+
+Both methods raise `JltConnectionError` on HTTP errors, connection errors and timeouts. All
+exceptions raised by the library inherit from `JltError`.
+
+### `Departure`
+
+| Attribute | Type | Example |
+|-----------|------|---------|
+| `line` | `str` | `"1"` |
+| `destination` | `str` | `"Huskvarna via Centrum-Elmia"` |
+| `direction` | `str` | `"mot Huskvarna via Centrum-Elmia"` |
+| `departure` | `datetime` | Timezone aware, in `JLT_TIMEZONE` (Europe/Stockholm) |
+| `departure_time` | `str` | `"11:41"` |
+| `time_to_departure` | `str` | `"Avgår om 5 min"` |
+
+### `Stop`
+
+| Attribute | Type | Example |
+|-----------|------|---------|
+| `id` | `int` | `6001320` |
+| `name` | `str` | `"Jönköping Rådhusparken"` |
+
+### Parsers
+
+`parse_departures(html, now)` and `parse_stops(html)` parse the HTML fragments without doing
+any network requests. `parse_departures` uses `now` to place the clock times on the right date,
+so departures after midnight end up on the next day.
+
+## Development
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+Tests marked `live` call the real jlt.se site to detect markup changes. Skip them with
+`pytest -m "not live"`.
+
+## Releasing
+
+Releases are published to PyPI by the `Publish to PyPI` workflow when a GitHub release is
+published, using [trusted publishing](https://docs.pypi.org/trusted-publishers/). Bump
+`__version__` in `src/jlt_bus_schedule/const.py` before creating the release.

jlt_bus_schedule-1.0.0/README.md

@@ -0,0 +1,118 @@
+# Python-JLT-BusSchedule-Scraper
+Python library that scrapes the JLT site for bus schedules. 
+
+[JLT (Jönköpings Länstrafik)](https://www.jlt.se) has no public API for departures, so this
+library scrapes the HTML fragment used by the departure board on jlt.se, and the stop search
+of the travel planner that jlt.se embeds from etiscloud.net.
+
+It is used by the [JLT Bus Schedule](https://github.com/jonnybergdahl/HomeAssistant_JltBusSchedule_Integration)
+Home Assistant integration.
+
+## Installation
+
+```bash
+pip install jlt-bus-schedule
+```
+
+Requires Python 3.11 or later.
+
+## Usage
+
+```python
+import asyncio
+
+from jlt_bus_schedule import JltApiClient
+
+
+async def main() -> None:
+    async with JltApiClient() as client:
+        stops = await client.async_search_stops("Rådhusparken")
+        stop = stops[0]
+        print(f"{stop.name} ({stop.id})")
+
+        for departure in await client.async_get_departures(stop.id, take=10):
+            print(
+                f"{departure.departure_time} {departure.line:>3} "
+                f"{departure.destination} ({departure.time_to_departure})"
+            )
+
+
+asyncio.run(main())
+```
+
+```
+Jönköping Rådhusparken (6001320)
+13:20   3 Råslätt via Asecs-Ryhov (Avgår nu)
+13:21 141 Sävsjö via Vrigstad (Avgår nu)
+13:22   4 Huskvarna via Solåsen-Ryhov (Avgår om 1 min)
+...
+```
+
+### Sharing an aiohttp session
+
+Pass an existing `aiohttp.ClientSession` to share it with the rest of your application, as
+Home Assistant integrations should. The client never closes a session it did not create.
+
+```python
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+
+client = JltApiClient(async_get_clientsession(hass))
+```
+
+Without a session the client creates its own, which is closed by `await client.close()` or when
+leaving an `async with` block.
+
+A custom `User-Agent` header can be set with `JltApiClient(session, user_agent="MyApp/1.0")`.
+
+## API
+
+### `JltApiClient`
+
+| Method | Description |
+|--------|-------------|
+| `async_get_departures(stop_id, take=20, timeout=10)` | Upcoming departures for all lines at a stop, as a list of `Departure`. Departures that have already left are skipped. |
+| `async_search_stops(query, timeout=10)` | Stops matching a name, best match first, as a list of `Stop`. |
+| `close()` | Close the session, if it was created by the client. |
+
+Both methods raise `JltConnectionError` on HTTP errors, connection errors and timeouts. All
+exceptions raised by the library inherit from `JltError`.
+
+### `Departure`
+
+| Attribute | Type | Example |
+|-----------|------|---------|
+| `line` | `str` | `"1"` |
+| `destination` | `str` | `"Huskvarna via Centrum-Elmia"` |
+| `direction` | `str` | `"mot Huskvarna via Centrum-Elmia"` |
+| `departure` | `datetime` | Timezone aware, in `JLT_TIMEZONE` (Europe/Stockholm) |
+| `departure_time` | `str` | `"11:41"` |
+| `time_to_departure` | `str` | `"Avgår om 5 min"` |
+
+### `Stop`
+
+| Attribute | Type | Example |
+|-----------|------|---------|
+| `id` | `int` | `6001320` |
+| `name` | `str` | `"Jönköping Rådhusparken"` |
+
+### Parsers
+
+`parse_departures(html, now)` and `parse_stops(html)` parse the HTML fragments without doing
+any network requests. `parse_departures` uses `now` to place the clock times on the right date,
+so departures after midnight end up on the next day.
+
+## Development
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+Tests marked `live` call the real jlt.se site to detect markup changes. Skip them with
+`pytest -m "not live"`.
+
+## Releasing
+
+Releases are published to PyPI by the `Publish to PyPI` workflow when a GitHub release is
+published, using [trusted publishing](https://docs.pypi.org/trusted-publishers/). Bump
+`__version__` in `src/jlt_bus_schedule/const.py` before creating the release.

jlt_bus_schedule-1.0.0/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "jlt-bus-schedule"
+dynamic = ["version"]
+description = "Async client that scrapes bus departures and stops from JLT (Jönköpings Länstrafik)"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Jonny Bergdahl" }]
+requires-python = ">=3.11"
+dependencies = [
+    "aiohttp>=3.9",
+    "beautifulsoup4>=4.12.0",
+    # Windows has no system timezone database for zoneinfo
+    "tzdata; sys_platform == 'win32'",
+]
+keywords = ["jlt", "jönköping", "bus", "public transport", "home assistant"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest>=8",
+    "pytest-asyncio>=0.24",
+]
+
+[project.urls]
+Homepage = "https://github.com/jonnybergdahl/Python-JLT-BusSchedule-Scraper"
+Issues = "https://github.com/jonnybergdahl/Python-JLT-BusSchedule-Scraper/issues"
+
+[tool.hatch.version]
+path = "src/jlt_bus_schedule/const.py"
+
+[tool.hatch.build.targets.sdist]
+include = ["src", "tests", "README.md", "LICENSE"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+markers = [
+    "live: tests that call the live jlt.se site, deselect with '-m \"not live\"'",
+]
+
+[tool.ruff.lint]
+select = ["B", "D", "E", "F", "I", "RUF", "SLF", "UP"]
+ignore = ["D203", "D213", "E501"]
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+combine-as-imports = true

jlt_bus_schedule-1.0.0/src/jlt_bus_schedule/__init__.py

@@ -0,0 +1,22 @@
+"""Async client for the JLT (Jönköpings Länstrafik) departure board."""
+
+from .client import JltApiClient
+from .const import API_URL, JLT_TIMEZONE, STOP_SEARCH_URL, USER_AGENT, __version__
+from .exceptions import JltConnectionError, JltError
+from .models import Departure, Stop
+from .parser import parse_departures, parse_stops
+
+__all__ = [
+    "API_URL",
+    "JLT_TIMEZONE",
+    "STOP_SEARCH_URL",
+    "USER_AGENT",
+    "Departure",
+    "JltApiClient",
+    "JltConnectionError",
+    "JltError",
+    "Stop",
+    "__version__",
+    "parse_departures",
+    "parse_stops",
+]

jlt_bus_schedule-1.0.0/src/jlt_bus_schedule/client.py

@@ -0,0 +1,95 @@
+"""Client for the JLT (Jönköpings Länstrafik) departure board.
+
+JLT has no public JSON API for departures, so this scrapes the HTML fragment
+used by the departure board on jlt.se, and the stop search of the travel
+planner that jlt.se embeds from etiscloud.net.
+"""
+
+from __future__ import annotations
+
+import asyncio
+from datetime import datetime
+from types import TracebackType
+from typing import Self
+
+import aiohttp
+
+from .const import API_URL, JLT_TIMEZONE, STOP_SEARCH_URL, USER_AGENT
+from .exceptions import JltConnectionError
+from .models import Departure, Stop
+from .parser import parse_departures, parse_stops
+
+
+class JltApiClient:
+    """Fetch departures and stops from JLT.
+
+    Pass an existing aiohttp session to share it with the rest of the
+    application. Without one, the client creates its own session, which is
+    closed by close() or when leaving an ``async with`` block.
+    """
+
+    def __init__(
+        self,
+        session: aiohttp.ClientSession | None = None,
+        user_agent: str = USER_AGENT,
+    ) -> None:
+        """Initialize the client."""
+        self._session = session
+        self._close_session = False
+        self._user_agent = user_agent
+
+    async def __aenter__(self) -> Self:
+        """Enter the async context manager."""
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
+        """Close the session if it was created by the client."""
+        await self.close()
+
+    async def close(self) -> None:
+        """Close the session if it was created by the client."""
+        if self._session and self._close_session:
+            await self._session.close()
+            self._session = None
+            self._close_session = False
+
+    async def _async_get(
+        self, url: str, params: dict[str, str | int], timeout: float
+    ) -> str:
+        """Fetch a URL and return the response body."""
+        if self._session is None:
+            self._session = aiohttp.ClientSession()
+            self._close_session = True
+
+        try:
+            async with asyncio.timeout(timeout):
+                async with self._session.get(
+                    url, params=params, headers={"User-Agent": self._user_agent}
+                ) as response:
+                    response.raise_for_status()
+                    return await response.text()
+        except (TimeoutError, aiohttp.ClientError) as err:
+            raise JltConnectionError(f"Error fetching {url}: {err}") from err
+
+    async def async_get_departures(
+        self, stop_id: int, take: int = 20, timeout: float = 10
+    ) -> list[Departure]:
+        """Return upcoming departures for all lines at a stop."""
+        html = await self._async_get(
+            API_URL, {"fromId": stop_id, "take": take}, timeout
+        )
+        return parse_departures(html, datetime.now(JLT_TIMEZONE))
+
+    async def async_search_stops(self, query: str, timeout: float = 10) -> list[Stop]:
+        """Return stops matching a name, best match first."""
+        html = await self._async_get(
+            STOP_SEARCH_URL,
+            {"fld": "input-from_ajax", "letters": query, "optType": 0},
+            timeout,
+        )
+        return parse_stops(html)

jlt_bus_schedule-1.0.0/src/jlt_bus_schedule/const.py

@@ -0,0 +1,15 @@
+"""Constants for the JLT client."""
+
+from zoneinfo import ZoneInfo
+
+__version__ = "1.0.0"
+
+API_URL = "https://www.jlt.se/api/StopAreaApi/GetClosestDepartures"
+STOP_SEARCH_URL = "https://www.etiscloud.net/jonkopingRP/v6/ajaxList.aspx"
+USER_AGENT = (
+    f"jlt-bus-schedule/{__version__} "
+    "(+https://github.com/jonnybergdahl/Python-JLT-BusSchedule-Scraper)"
+)
+
+# Departure times on jlt.se are always Swedish local time
+JLT_TIMEZONE = ZoneInfo("Europe/Stockholm")