bhs-calendars 2.8.1__tar.gz

bhs_calendars-2.8.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Peter Seibel
+
+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.

bhs_calendars-2.8.1/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: bhs-calendars
+Version: 2.8.1
+Summary: Bundled BHS-area school bell-schedule calendar data for the bells library
+Author: Peter Seibel
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/gigamonkey/bells
+Project-URL: Repository, https://github.com/gigamonkey/bells
+Project-URL: Bug Tracker, https://github.com/gigamonkey/bells/issues
+Keywords: bell schedule,school,calendar,berkeley high,bhs,education,data
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Education
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# bhs-calendars (Python)
+
+Bundled bell-schedule calendar data for Berkeley High School and nearby middle
+schools, as a Python distribution. This is the Python counterpart of the npm
+[`@peterseibel/bhs-calendars`](https://github.com/gigamonkey/bells/tree/main/bhs-calendars) package and ships the same
+per-year JSON.
+
+It is data, not logic — pair it with the [`bells`](https://github.com/gigamonkey/bells/tree/main/libs/python) library to build
+schedules without supplying your own `{year}.json` files.
+
+```sh
+pip install bhs-calendars
+```
+
+## Usage
+
+```python
+from bhs_calendars import by_id, load_all
+from bells import BellSchedule
+
+# Grouped by school, each school's years sorted chronologically:
+years = by_id()["bhs"]
+schedule = BellSchedule(years, {})
+
+# Or the flat list of every bundled school-year:
+all_years = load_all()   # list[dict]
+```
+
+`load_all()` mirrors the npm package's default export (a flat list of yearly
+calendar objects). `by_id()` groups those by their `id` field — `"bhs"`,
+`"king-6"`, `"king-7"`, `"king-8"`, `"longfellow-6"`, `"longfellow-78"`,
+`"willard-6"`, `"willard-78"` — with each group's years sorted by `firstDay`.
+
+Unlike the library's `Calendars` loader (which reads `{year}.json` from a
+directory or URL), this data is bundled on disk with the package: no filesystem
+layout or network access required. The trade-off is that it only covers the
+BHS-area schools.
+
+## Data source
+
+The JSON under `bhs_calendars/data/` is copied verbatim from the canonical
+`bhs-calendars/` directory at the repository root (the npm package source). Run
+`make sync-calendars` from the repo root to refresh it after the source data
+changes.

bhs_calendars-2.8.1/README.md

@@ -0,0 +1,44 @@
+# bhs-calendars (Python)
+
+Bundled bell-schedule calendar data for Berkeley High School and nearby middle
+schools, as a Python distribution. This is the Python counterpart of the npm
+[`@peterseibel/bhs-calendars`](https://github.com/gigamonkey/bells/tree/main/bhs-calendars) package and ships the same
+per-year JSON.
+
+It is data, not logic — pair it with the [`bells`](https://github.com/gigamonkey/bells/tree/main/libs/python) library to build
+schedules without supplying your own `{year}.json` files.
+
+```sh
+pip install bhs-calendars
+```
+
+## Usage
+
+```python
+from bhs_calendars import by_id, load_all
+from bells import BellSchedule
+
+# Grouped by school, each school's years sorted chronologically:
+years = by_id()["bhs"]
+schedule = BellSchedule(years, {})
+
+# Or the flat list of every bundled school-year:
+all_years = load_all()   # list[dict]
+```
+
+`load_all()` mirrors the npm package's default export (a flat list of yearly
+calendar objects). `by_id()` groups those by their `id` field — `"bhs"`,
+`"king-6"`, `"king-7"`, `"king-8"`, `"longfellow-6"`, `"longfellow-78"`,
+`"willard-6"`, `"willard-78"` — with each group's years sorted by `firstDay`.
+
+Unlike the library's `Calendars` loader (which reads `{year}.json` from a
+directory or URL), this data is bundled on disk with the package: no filesystem
+layout or network access required. The trade-off is that it only covers the
+BHS-area schools.
+
+## Data source
+
+The JSON under `bhs_calendars/data/` is copied verbatim from the canonical
+`bhs-calendars/` directory at the repository root (the npm package source). Run
+`make sync-calendars` from the repo root to refresh it after the source data
+changes.

bhs_calendars-2.8.1/bhs_calendars/__init__.py

@@ -0,0 +1,50 @@
+"""bhs-calendars — bundled BHS-area school bell-schedule calendar data.
+
+Python counterpart of the npm ``@peterseibel/bhs-calendars`` package. Ships the
+per-year calendar JSON for Berkeley High and nearby middle schools as package
+data and exposes it as plain dictionaries, ready to hand to
+``bells.BellSchedule``.
+
+Group the flat list by the ``id`` field to assemble the year sequence for a
+single school; a ``BellSchedule`` consumes one such group.
+"""
+
+from __future__ import annotations
+
+import json
+from collections import defaultdict
+from importlib.resources import files
+
+__all__ = ["load_all", "by_id"]
+
+__version__ = "2.8.1"
+
+
+def load_all() -> list[dict]:
+    """Return every bundled yearly calendar object as a flat list.
+
+    Parallels the npm package's default export. Each entry is one school-year;
+    group by the ``id`` field (or use :func:`by_id`) to get a single school's
+    years.
+    """
+    out: list[dict] = []
+    data_dir = files(__package__).joinpath("data")
+    for entry in sorted(data_dir.iterdir(), key=lambda p: p.name):
+        if entry.name.endswith(".json"):
+            data = json.loads(entry.read_text(encoding="utf-8"))
+            out.extend(data if isinstance(data, list) else [data])
+    return out
+
+
+def by_id() -> dict[str, list[dict]]:
+    """Group :func:`load_all` by ``id``, each group's years sorted by ``firstDay``.
+
+    Returns a mapping of school id (e.g. ``"bhs"``, ``"king-6"``) to that
+    school's years in chronological order.
+    """
+    groups: dict[str, list[dict]] = defaultdict(list)
+    for year in load_all():
+        groups[year["id"]].append(year)
+    for years in groups.values():
+        years.sort(key=lambda y: y["firstDay"])
+    return dict(groups)