luciole-toolbox 0.1.0__tar.gz

luciole_toolbox-0.1.0/.github/SETUP.md

@@ -0,0 +1,40 @@
+# One-time repo/account setup for the workflows
+
+This step happens outside this repo and can't be scripted from here — do
+it once before the `release.yml` workflow can succeed.
+
+## PyPI Trusted Publishing (needed for `release.yml`)
+
+Trusted Publishing lets GitHub Actions publish to PyPI via OIDC, with no
+API token stored as a repo secret.
+
+1. Create the `luciole-toolbox` project on PyPI if it doesn't exist yet
+   (first publish can also be done manually once to reserve the name —
+   trusted publishing can be configured before or after that).
+2. Go to <https://pypi.org/manage/project/luciole-toolbox/settings/publishing/>
+   (or, for a not-yet-existing project, <https://pypi.org/manage/account/publishing/>
+   to pre-register a "pending" publisher).
+3. Add a new trusted publisher with:
+   - **Owner**: `info-fauna`
+   - **Repository name**: `luciole-toolbox`
+   - **Workflow name**: `release.yml`
+   - **Environment name**: `pypi`
+4. In the GitHub repo, go to **Settings → Environments → New environment**,
+   name it `pypi` (must match exactly). Optionally add required reviewers
+   here if you want a manual approval gate before every publish.
+
+No secrets to add — `id-token: write` permission in `release.yml` handles
+the OIDC handshake.
+
+## Triggering a release
+
+Once the trusted publisher above is configured:
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+This triggers `release.yml`, which builds the package (version comes from
+the tag via `hatch-vcs`), publishes to PyPI, and creates a GitHub Release
+with auto-generated notes and the built artifacts attached.

luciole_toolbox-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ".[dev]"
+      - run: ruff check .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install ".[dev]"
+      - run: pytest -m "not integration"

luciole_toolbox-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,44 @@
+name: Docs
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: docs-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ".[docs]"
+      - run: mkdocs build --strict
+      - uses: actions/upload-pages-artifact@v3
+        if: github.event_name == 'push'
+        with:
+          path: site
+
+  deploy:
+    if: github.event_name == 'push'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

luciole_toolbox-0.1.0/.github/workflows/integration.yml

@@ -0,0 +1,24 @@
+name: Integration tests
+
+on:
+  push:
+    branches: [main]
+  schedule:
+    - cron: "0 4 * * 1" # weekly (Monday) - catch upstream drift in swisstopo API / pyproj CDN even without new commits
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  integration:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ".[dev]"
+      - run: pytest -m integration

luciole_toolbox-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,55 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # trusted publishing (OIDC) - no PyPI token stored as a secret
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+          files: dist/*

luciole_toolbox-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.venv/
+venv/
+build/
+dist/
+.mypy_cache/
+.ruff_cache/
+misc/
+src/luciole_toolbox/_version.py
+site/

luciole_toolbox-0.1.0/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

luciole_toolbox-0.1.0/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+Format based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+### Added
+
+- `geo` module: CRS detection (WGS84/LV03/LV95), coordinate conversion,
+  CKM2/CNHA grid codes, and commune/canton lookup via the swisstopo API.

luciole_toolbox-0.1.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.5
+Name: luciole-toolbox
+Version: 0.1.0
+Author-email: Kim Biloni <kim.biloni@infofauna.ch>
+License-Expression: MIT
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: pyproj>=3.6
+Requires-Dist: requests>=2.31
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
+Requires-Dist: mkdocs>=1.6; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.26; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# luciole-toolbox
+
+[![CI](https://github.com/info-fauna/luciole-toolbox/actions/workflows/ci.yml/badge.svg)](https://github.com/info-fauna/luciole-toolbox/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/luciole-toolbox.svg)](https://pypi.org/project/luciole-toolbox/)
+
+Python utility library. Currently ships a `geo` module for Swiss coordinates:
+CRS detection (WGS84/LV03/LV95), conversion between them, CKM2/CNHA grid
+codes, and commune/canton lookup via the swisstopo API.
+
+## Installation
+
+```bash
+pip install luciole-toolbox
+```
+
+## Usage
+
+```python
+from luciole_toolbox.geo import convert_coordinates, get_location_info, CRSType
+
+convert_coordinates("46.9480", "7.4474", target=CRSType.LV95)
+get_location_info("46.9480", "7.4474")
+```
+
+Full API reference: <https://info-fauna.github.io/luciole-toolbox/>
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+```
+
+### Testing
+
+```bash
+pytest                      # all tests, incl. calls to swisstopo/pyproj CDN
+pytest -m "not integration" # skip tests hitting real network endpoints
+```
+
+### Docs
+
+```bash
+pip install -e ".[docs]"
+mkdocs serve # preview locally at http://127.0.0.1:8000
+```
+
+## Versioning & releases
+
+The version is derived from git tags via `hatch-vcs` — there is no version
+string to hand-edit. Notable changes are tracked in
+[CHANGELOG.md](CHANGELOG.md). To cut a release, push a tag:
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+This triggers the `release` workflow, which builds the package, publishes
+it to PyPI, and creates a matching GitHub Release.

luciole_toolbox-0.1.0/README.md

@@ -0,0 +1,59 @@
+# luciole-toolbox
+
+[![CI](https://github.com/info-fauna/luciole-toolbox/actions/workflows/ci.yml/badge.svg)](https://github.com/info-fauna/luciole-toolbox/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/luciole-toolbox.svg)](https://pypi.org/project/luciole-toolbox/)
+
+Python utility library. Currently ships a `geo` module for Swiss coordinates:
+CRS detection (WGS84/LV03/LV95), conversion between them, CKM2/CNHA grid
+codes, and commune/canton lookup via the swisstopo API.
+
+## Installation
+
+```bash
+pip install luciole-toolbox
+```
+
+## Usage
+
+```python
+from luciole_toolbox.geo import convert_coordinates, get_location_info, CRSType
+
+convert_coordinates("46.9480", "7.4474", target=CRSType.LV95)
+get_location_info("46.9480", "7.4474")
+```
+
+Full API reference: <https://info-fauna.github.io/luciole-toolbox/>
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+```
+
+### Testing
+
+```bash
+pytest                      # all tests, incl. calls to swisstopo/pyproj CDN
+pytest -m "not integration" # skip tests hitting real network endpoints
+```
+
+### Docs
+
+```bash
+pip install -e ".[docs]"
+mkdocs serve # preview locally at http://127.0.0.1:8000
+```
+
+## Versioning & releases
+
+The version is derived from git tags via `hatch-vcs` — there is no version
+string to hand-edit. Notable changes are tracked in
+[CHANGELOG.md](CHANGELOG.md). To cut a release, push a tag:
+
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+This triggers the `release` workflow, which builds the package, publishes
+it to PyPI, and creates a matching GitHub Release.

luciole_toolbox-0.1.0/docs/index.md

@@ -0,0 +1,22 @@
+# Luciole Toolbox
+
+Python utility library. Currently ships a `geo` module for Swiss coordinates:
+CRS detection (WGS84/LV03/LV95), conversion between them, CKM2/CNHA grid
+codes, and commune/canton lookup via the swisstopo API.
+
+## Installation
+
+```bash
+pip install luciole-toolbox
+```
+
+## Usage
+
+```python
+from luciole_toolbox.geo import convert_coordinates, get_location_info, CRSType
+
+convert_coordinates("46.9480", "7.4474", target=CRSType.LV95)
+get_location_info("46.9480", "7.4474")
+```
+
+See the [API Reference](reference.md) for full details.

luciole_toolbox-0.1.0/docs/reference.md

@@ -0,0 +1,3 @@
+# API Reference
+
+::: luciole_toolbox.geo

luciole_toolbox-0.1.0/mkdocs.yml

@@ -0,0 +1,29 @@
+site_name: Luciole Toolbox
+site_description: Python utility library for Swiss geodata handling.
+repo_url: https://github.com/info-fauna/luciole-toolbox
+repo_name: info-fauna/luciole-toolbox
+
+theme:
+  name: material
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+nav:
+  - Home: index.md
+  - API Reference: reference.md
+
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_source: false
+            show_root_heading: true

luciole_toolbox-0.1.0/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "luciole-toolbox"
+dynamic = ["version"]
+description = ""
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [
+    { name = "Kim Biloni", email = "kim.biloni@infofauna.ch" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "pyproj>=3.6",
+    "requests>=2.31",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "ruff>=0.6",
+]
+docs = [
+    "mkdocs>=1.6",
+    "mkdocs-material>=9.5",
+    "mkdocstrings[python]>=0.26",
+]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/luciole_toolbox/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/luciole_toolbox"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers = [
+    "integration: hits a real network endpoint (swisstopo API, pyproj CDN grid shift files) - excluded via -m 'not integration'",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]

luciole_toolbox-0.1.0/src/luciole_toolbox/__init__.py

@@ -0,0 +1,3 @@
+from luciole_toolbox._version import __version__
+
+__all__ = ["__version__"]

luciole_toolbox-0.1.0/src/luciole_toolbox/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = None