multimodalpy 0.1.1__tar.gz

multimodalpy-0.1.1/.github/workflows/docs.yml

@@ -0,0 +1,42 @@
+name: Docs
+
+on:
+  pull_request:
+    branches: [develop, main]
+    paths:
+      - "docs/**"
+      - "src/**"
+      - ".readthedocs.yaml"
+      - ".github/workflows/docs.yml"
+  push:
+    branches: [develop, main]
+    paths:
+      - "docs/**"
+      - "src/**"
+      - ".readthedocs.yaml"
+      - ".github/workflows/docs.yml"
+
+jobs:
+  build:
+    name: Build Sphinx docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install package with docs dependencies
+        run: pip install -e . --group docs
+
+      - name: Build docs (fail on warnings)
+        run: sphinx-build -b html -W docs docs/_build/html
+
+      - name: Upload built docs as an artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs-html
+          path: docs/_build/html
+          retention-days: 7

multimodalpy-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,82 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  # Allows manually publishing to TestPyPI without cutting a real release.
+  workflow_dispatch:
+    inputs:
+      target:
+        description: "Where to publish"
+        required: true
+        default: "testpypi"
+        type: choice
+        options:
+          - testpypi
+          - pypi
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install build tool
+        run: pip install build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    if: github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'testpypi'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/multimodalpy/
+    permissions:
+      id-token: write  # required for Trusted Publishing (OIDC)
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    name: Publish to PyPI
+    if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'pypi')
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/multimodalpy/
+    permissions:
+      id-token: write  # required for Trusted Publishing (OIDC)
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

multimodalpy-0.1.1/.github/workflows/tests.yml

@@ -0,0 +1,43 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install package
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+
+      - name: Install dev dependency group
+        run: pip install --group dev
+
+      - name: Run tests with coverage
+        run: |
+          pytest --cov=multimodalpy --cov-report=xml --cov-report=term-missing
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false

multimodalpy-0.1.1/.gitignore

@@ -0,0 +1,19 @@
+# Sistema operativo
+.DS_Store
+
+# Python
+__pycache__/
+*.pyc
+.coverage
+
+# Build artifacts
+dist/
+build/
+*.egg-info/
+
+# Docs build output
+docs/_build/
+docs/_autosummary/
+
+# Datos generados
+data/outputs/

multimodalpy-0.1.1/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements: []
+    - requirements: docs/requirements.txt

multimodalpy-0.1.1/ARCHITECTURE.md

@@ -0,0 +1,50 @@
+multimodalpy/
+├── LICENSE
+├── README.md
+├── ARCHITECTURE.md
+├── CONTRIBUTING.md
+├── CODE_OF_CONDUCT.md
+├── CITATION.cff
+├── CHANGELOG.md
+├── pyproject.toml
+├── .gitignore
+├── .readthedocs.yaml
+│
+├── .github/
+│   └── workflows/
+│       ├── tests.yml          # pytest + mypy + ruff, on push/PR
+│       ├── docs.yml           # Sphinx build check, on push/PR
+│       └── publish.yml        # build + publish to (Test)PyPI on release
+│
+├── src/
+│   └── multimodalpy/
+│       ├── __init__.py
+│       ├── get_area.py        # study-area boundary resolution (pooch-fetched
+│       │                      # default boundaries; see DATA_SCHEMA.md)
+│       ├── get_network.py     # main() entry point: OSM + GTFS -> network
+│       ├── process_osm.py     # OSM download/normalization per mode
+│       └── process_gtfs.py    # GTFS download/normalization via NAP
+│
+├── tests/
+│   ├── test_get_area_cities.py
+│   ├── test_get_network.py
+│   └── test_output_format.py
+│
+└── docs/
+    ├── conf.py                # Sphinx config (pydata-sphinx-theme)
+    ├── index.md
+    ├── api.md                 # autosummary-generated API reference
+    └── requirements.txt       # pinned docs deps for Read the Docs' isolated build
+
+Notes
+-----
+- No `data/` folder is tracked in the repository. The default study-area
+  boundaries are downloaded on demand via `pooch.retrieve()` from a GitHub
+  release asset and cached locally (see `get_area.py`); this keeps the repo
+  small and avoids committing large binary geospatial files to git history.
+- `dist/` (build artifacts from `python -m build`) is git-ignored; each
+  release version's wheel/sdist filenames are permanently reserved by
+  PyPI/TestPyPI once uploaded, so they must never be committed.
+- Documentation is built by Read the Docs from `.readthedocs.yaml` +
+  `docs/`; `docs.yml` in CI is a build-check only (fails PRs that break the
+  Sphinx build), it does not deploy.

multimodalpy-0.1.1/CHANGELOG.md

@@ -0,0 +1,46 @@
+# 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).
+
+## [Unreleased]
+
+### Added
+- `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md`, aligning the project with
+  pyOpenSci's peer-review documentation requirements.
+- Sphinx + Read the Docs configuration (`docs/`, `.readthedocs.yaml`) for
+  auto-generated API reference documentation.
+- `CITATION.cff` for machine-readable citation metadata.
+
+### Fixed
+- Corrected `.gitignore` so build artifacts in `dist/` are actually
+  excluded from version control (previous pattern only matched a nested,
+  nonexistent `data/outputs/dist/` path).
+- Removed the tracked `data/` folder from the repository; the default
+  municipal boundaries are already fetched at runtime via `pooch` from a
+  GitHub release asset, so bundling them in the repo was redundant.
+- Restored nested `{mode}/{dataset}/...` output paths for GTFS layers
+  (nodes, edges, schedule tables) that were dropped during a merge
+  conflict resolution.
+
+## [0.1.1] - 2026-09-30
+
+### Changed
+- Republished to TestPyPI with corrected README (installation
+  instructions, badges, repository links) and dev-install instructions
+  matching the project's `[dependency-groups]` setup
+  (`pip install -e . --group dev`).
+
+## [0.1.0] - 2026-09-30
+
+### Added
+- Initial release: OSM + GTFS multimodal network download and export
+  pipeline (`get_network.main`), supporting GeoJSON, Shapefile,
+  GeoPackage, and NetworkX graph output formats.
+- Published to TestPyPI for pre-release testing.
+
+[Unreleased]: https://github.com/aivilor/multimodalpy/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/aivilor/multimodalpy/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/aivilor/multimodalpy/releases/tag/v0.1.0

multimodalpy-0.1.1/CITATION.cff

@@ -0,0 +1,24 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+type: software
+title: "multimodalpy"
+abstract: >-
+  Easy creation of multimodal transport networks from OpenStreetMap and
+  GTFS data.
+authors:
+  - family-names: "Villalba Ortiz"
+    given-names: "Aida"
+    email: "aivilor@upv.es"
+    affiliation: "Universitat Politècnica de València"
+version: 0.1.1
+date-released: 2026-09-30
+url: "https://github.com/aivilor/multimodalpy"
+repository-code: "https://github.com/aivilor/multimodalpy"
+license: MIT
+keywords:
+  - multimodal
+  - transport networks
+  - OpenStreetMap
+  - GTFS
+  - geospatial
+  - Python

multimodalpy-0.1.1/CODE_OF_CONDUCT.md

@@ -0,0 +1,113 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances
+  of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards
+of acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, issues, and other contributions that are not aligned
+to this Code of Conduct, and will communicate reasons for moderation decisions
+when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces (GitHub issues, pull
+requests, discussions) and also applies when an individual is officially
+representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the project maintainer at **aivilor@upv.es**. All complaints will
+be reviewed and investigated promptly and fairly.
+
+All maintainers are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Maintainers will follow these Community Impact Guidelines in determining the
+consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome.
+
+**Consequence**: A private, written warning, providing clarity around the
+nature of the violation and an explanation of why the behavior was
+inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved for a specified period of time. Violating
+these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

multimodalpy-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing to multimodalpy
+
+Thanks for your interest in contributing! `multimodalpy` is a small, community-friendly scientific Python package, and contributions of all kinds are welcome — bug reports, documentation fixes, new features, and code review.
+
+## Ways to contribute
+
+- **Report a bug or request a feature**: [open an issue](https://github.com/aivilor/multimodalpy/issues) with as much detail as possible (Python version, OS, a minimal reproducible example for bugs).
+- **Improve documentation**: typo fixes, clearer examples, and new tutorials are all valuable and don't require deep familiarity with the codebase.
+- **Fix a bug or add a feature**: see the development setup below, then open a pull request.
+- **Review pull requests**: feedback on open PRs is welcome even if you're not the author.
+
+## Development setup
+
+1. Fork the repository and clone your fork:
+   ```bash
+   git clone https://github.com/<your-username>/multimodalpy.git
+   cd multimodalpy
+   ```
+
+2. Create a virtual environment and install the package in editable mode with development dependencies:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # on Windows: .venv\Scripts\activate
+   pip install -e . --group dev
+   ```
+   (requires pip ≥ 25.1 for the `--group` flag; alternatively, with [uv](https://docs.astral.sh/uv/): `uv sync --group dev`)
+
+3. Create a branch for your change:
+   ```bash
+   git checkout -b fix/short-description-of-change
+   ```
+
+## Running the checks locally
+
+Before opening a pull request, make sure the full check suite passes — this is the same suite run in CI:
+
+```bash
+python -m pytest       # test suite + coverage report
+python -m mypy         # static type checking
+python -m ruff check . # linting
+```
+
+All three must pass cleanly for a PR to be merged.
+
+### Code style
+
+- Code is formatted and linted with [ruff](https://docs.astral.sh/ruff/) (line length 88, numpy-style docstrings).
+- Type-check with [mypy](https://mypy-lang.org/); please add type hints to new public functions.
+- Docstrings follow the [numpy docstring convention](https://numpydoc.readthedocs.io/en/latest/format.html) (see existing functions in `src/multimodalpy/` for examples).
+
+## Submitting a pull request
+
+1. Push your branch and open a pull request against **`develop`** (not `main`) — this repo develops on `develop` and releases from `main`.
+2. Fill in the PR description: what changed and why, and how you tested it.
+3. Make sure CI (GitHub Actions `Tests` workflow) passes on your PR.
+4. Be responsive to review feedback — most PRs go through at least one round of comments.
+
+## Reporting security issues
+
+Please do not open a public issue for security-sensitive bugs. Instead, email the maintainer directly at aivilor@upv.es.
+
+## Code of Conduct
+
+This project follows the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to abide by its terms.
+
+## Questions?
+
+If anything here is unclear, open an issue and ask — improving these docs based on real questions is itself a welcome contribution.