tiny-osm 0.1.0__tar.gz

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

@@ -0,0 +1,67 @@
+name: Docs
+
+on:
+  push:
+    branches:
+    - main
+    tags:
+    - v*
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+concurrency:
+  group: docs-deploy
+  cancel-in-progress: false
+
+jobs:
+  docs:
+    name: Deploy Documentation
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+
+    - uses: prefix-dev/setup-pixi@v0.9.4
+      with:
+        pixi-version: v0.67.0
+        environments: docs
+        activate-environment: docs
+        locked: true
+
+    - name: Configure Git
+      run: |-
+        git config user.name "github-actions[bot]"
+        git config user.email "github-actions[bot]@users.noreply.github.com"
+
+    - name: Fetch gh-pages branch
+      run: git fetch origin gh-pages:gh-pages || true
+
+    - name: Deploy latest docs (main branch)
+      if: github.ref == 'refs/heads/main'
+      run: |-
+        pixi r docs-deploy
+        mike set-default --push latest
+
+    - name: Deploy release docs (tagged version)
+      if: startsWith(github.ref, 'refs/tags/v')
+      run: |-
+        VERSION=$(git describe --tags --abbrev=0)
+        # Find the previous stable version before deploying
+        PREV=$(mike list --json 2>/dev/null | python3 -c "
+        import json, sys
+        versions = json.load(sys.stdin)
+        prev = [v['version'] for v in versions if 'stable' in v.get('aliases', [])]
+        print(prev[0] if prev else '')
+        " || true)
+        # Deploy new version with stable alias
+        pixi r docs-release
+        mike retitle --push "$VERSION" "$VERSION (stable)"
+        # Remove (stable) label from previous version
+        if [ -n "$PREV" ] && [ "$PREV" != "$VERSION" ]; then
+          mike retitle --push "$PREV" "$PREV"
+        fi
+        mike set-default --push latest

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

@@ -0,0 +1,72 @@
+name: Publish
+
+on:
+  push:
+    tags:
+    - v*
+  workflow_dispatch: # allows you to trigger manually
+
+permissions:
+  contents: write
+  attestations: write
+  id-token: write
+
+jobs:
+  release-notes:
+    name: Create Release Notes
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+
+    - name: Generate release notes with git-cliff
+      uses: orhun/git-cliff-action@v4
+      with:
+        config: pyproject.toml
+        args: --latest --strip all
+      env:
+        OUTPUT: release-notes.md
+        GITHUB_REPO: ${{ github.repository }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Create GitHub Release
+      uses: softprops/action-gh-release@v2
+      if: startsWith(github.ref, 'refs/tags/')
+      with:
+        body_path: release-notes.md
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  build-package:
+    name: Build and Inspect Python Package
+    runs-on: ubuntu-latest
+    needs: release-notes
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+
+    - uses: hynek/build-and-inspect-python-package@v2
+      with:
+        attest-build-provenance-github: true
+
+  release-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: build-package
+
+    steps:
+    - name: Download packages built by build-and-inspect-python-package
+      uses: actions/download-artifact@v8
+      with:
+        name: Packages
+        path: dist
+
+    - name: Generate artifact attestation for sdist and wheel
+      uses: actions/attest-build-provenance@v4
+      with:
+        subject-path: dist
+
+    - name: Upload package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

tiny_osm-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches:
+    - '**'
+    tags-ignore:
+    - '**'
+  pull_request:
+    branches:
+    - '**'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: unit - ${{ matrix.environment }}, ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        environment: [test311, test314]
+
+    steps:
+    - uses: actions/checkout@v6
+    - uses: prefix-dev/setup-pixi@v0.9.4
+      with:
+        pixi-version: v0.67.0
+        environments: ${{ matrix.environment }}
+        activate-environment: ${{ matrix.environment }}
+        locked: true
+    - name: Run unit tests
+      run: pixi r test
+
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        slug: ${{ github.event.repository.owner.login }}/${{ github.event.repository.name }}
+
+  test-network:
+    name: network - test314, ubuntu-latest
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+    - uses: prefix-dev/setup-pixi@v0.9.4
+      with:
+        pixi-version: v0.67.0
+        environments: test314
+        activate-environment: test314
+        locked: true
+    - name: Run network tests
+      run: pixi r test-network
+
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        slug: ${{ github.event.repository.owner.login }}/${{ github.event.repository.name }}

tiny_osm-0.1.0/.gitignore

@@ -0,0 +1,118 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+.pytest_tmp/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+# Note: docs/examples/*.ipynb ARE tracked - they are generated from the
+# paired .py (percent format) files via `pixi r nb-sync` and executed via
+# `pixi r nb-execute`. Strip outputs before committing with `pixi r nb-clear`.
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# IDE settings
+.vscode/
+.idea/
+
+# logs
+cache
+.pixi
+.DS_Store
+junit.xml
+.coverage
+*.egg-info
+data
+.nox

tiny_osm-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,98 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: check-added-large-files
+    args: [--maxkb=50000]
+  - id: mixed-line-ending
+    args: [--fix=lf]
+  - id: check-ast
+    exclude: ^docs/examples/notebooks/.*\.py$
+  - id: check-builtin-literals
+    exclude: ^docs/examples/notebooks/.*\.py$
+  - id: check-case-conflict
+  - id: check-docstring-first
+  - id: check-shebang-scripts-are-executable
+  - id: check-merge-conflict
+  - id: check-json
+  - id: check-toml
+  - id: check-xml
+  - id: check-yaml
+    exclude: mkdocs.yml
+  - id: debug-statements
+    exclude: ^docs/examples/notebooks/.*\.py$
+  - id: destroyed-symlinks
+  - id: detect-private-key
+  - id: end-of-file-fixer
+    exclude: ^LICENSE|\.(html|csv|txt|svg|py)$
+  - id: pretty-format-json
+    args: [--autofix, --no-ensure-ascii, --no-sort-keys]
+  - id: trailing-whitespace
+    args: [--markdown-linebreak-ext=md]
+    exclude: \.(html|svg)$
+
+- repo: https://github.com/bwhmather/ssort
+  rev: 0.16.0
+  hooks:
+  - id: ssort
+    name: Sort top level statements with ssort
+    exclude: ^docs/examples/notebooks/.*\.py$
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.15.10
+  hooks:
+  - id: ruff
+    name: Linting with Ruff
+    types_or: [python, jupyter]
+    args: [--fix, --unsafe-fixes]
+  - id: ruff-format
+    name: Formatting with Ruff
+    types_or: [python, jupyter]
+
+
+- repo: https://github.com/PyCQA/doc8
+  rev: v2.0.0
+  hooks:
+  - id: doc8
+    name: Check documentation formats with doc8
+    args: [--max-line-length, '100']
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.4.2
+  hooks:
+  - id: codespell
+    name: Check common misspellings in text files with codespell.
+    additional_dependencies:
+    - tomli
+
+- repo: https://github.com/tox-dev/pyproject-fmt
+  rev: v2.21.1
+  hooks:
+  - id: pyproject-fmt
+    name: Apply a consistent format to pyproject.toml
+
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.16.0
+  hooks:
+  - id: pretty-format-yaml
+    args: [--autofix, --indent, '2']
+
+- repo: https://github.com/rhysd/actionlint
+  rev: v1.7.12
+  hooks:
+  - id: actionlint
+    files: .github/workflows/
+    args: [-ignore, SC1090, -ignore, SC2046, -ignore, SC2086, -ignore, SC2129, -ignore, SC2155, -ignore, property "date"]
+
+- repo: https://github.com/executablebooks/mdformat
+  rev: 1.0.0
+  hooks:
+  - id: mdformat
+    additional_dependencies:
+    - mdformat-mkdocs
+    - mdformat-ruff
+    - ruff
+    - mdformat-config
+    - mdformat-toc
+    args: [--wrap, '88']
+    exclude: ^docs/reference/

tiny_osm-0.1.0/AUTHORS.md

@@ -0,0 +1,3 @@
+# Authors
+
+- Taher Chegini ([@cheginit](https://github.com/cheginit))

tiny_osm-0.1.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. The format is based
+on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-04-16
+
+### Added
+
+- Single-function API (`fetch`) to retrieve OSM data as GeoJSON FeatureCollections
+- Predefined Overpass QL filters via `OSMFilters` (HIGHWAY, WATERWAY, WATER_BODY)
+- Support for any custom Overpass QL tag-filter string
+- Automatic bounding box subdivision into tiles for large queries
+- Multi-mirror retry with automatic failover across Overpass API endpoints
+- Full GeoJSON assembly: ring stitching, hole assignment, polygon-feature rule tree
+- Element deduplication across tile boundaries
+- Module-level HTTP connection pooling for TLS reuse across `fetch` calls
+- Configurable logging via `configure_logger`

tiny_osm-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,36 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a
+harassment-free experience for everyone.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior:
+
+- The use of sexualized language or imagery
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional
+    setting
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to
+the project maintainers. All complaints will be reviewed and investigated promptly and
+fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the
+[Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

tiny_osm-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,110 @@
+# Contributing
+
+Thank you for your interest in contributing!
+
+## Development Setup
+
+1. Install [pixi](https://pixi.sh) and [gh](https://github.com/cli/cli#installation).
+1. Clone the repository.
+1. Set up the development environment:
+
+```console
+pixi install -e dev
+pixi install -e typecheck
+```
+
+1. Install pre-commit hooks:
+
+```console
+pixi r pcupdate  # optionally bump hooks to latest versions first
+pixi r lint      # installs hooks and runs them across the repo
+```
+
+## Commit Messages
+
+This project uses
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). All commit
+messages **must** follow this format:
+
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+### Types
+
+| Type       | When to use                            | Changelog section |
+| ---------- | -------------------------------------- | ----------------- |
+| `feat`     | A new feature                          | Added             |
+| `fix`      | A bug fix                              | Fixed             |
+| `perf`     | A performance improvement              | Changed           |
+| `refactor` | Code restructuring, no behavior change | Changed           |
+| `revert`   | Reverting a previous commit            | Fixed             |
+| `docs`     | Documentation only                     | _(skipped)_       |
+| `test`     | Adding or updating tests               | _(skipped)_       |
+| `chore`    | Maintenance, dependencies, tooling     | _(skipped)_       |
+| `ci`       | CI/CD changes                          | _(skipped)_       |
+
+### Breaking Changes
+
+Append `!` after the type, or add `BREAKING CHANGE:` in the footer:
+
+```
+feat!: drop support for Python 3.11
+```
+
+```
+feat: new API
+
+BREAKING CHANGE: `old_function` has been removed.
+```
+
+### Examples
+
+```
+feat(osm): add support for railway layer
+fix: handle missing CRS in bbox reprojection
+chore: bump ruff to v0.15.5
+docs: add example notebook for water_body fetch
+```
+
+## Running Tests
+
+```console
+pixi r test          # unit tests only
+pixi r test-network  # network tests only
+pixi r test-all      # all tests
+```
+
+## Type Checking
+
+```console
+pixi r typecheck
+```
+
+## Documentation
+
+```console
+pixi r docs-serve
+```
+
+## Managing the Changelog
+
+The changelog is maintained by [git-cliff](https://git-cliff.org) and generated
+automatically from conventional commit messages.
+
+```console
+pixi r changelog        # preview unreleased changes
+pixi r changelog-update # write them to CHANGELOG.md
+```
+
+## Submitting Changes
+
+1. Fork the repository.
+1. Create a feature branch.
+1. Make your changes with tests.
+1. Ensure all checks pass.
+1. Submit a pull request.

tiny_osm-0.1.0/LICENSE

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