wrgd 0.18.0__tar.gz

wrgd-0.18.0/CHANGELOG.md

@@ -0,0 +1,275 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is inspired by Keep a Changelog.
+This project follows Semantic Versioning.
+
+---
+
+## v0.18.0 - Sprint 17
+
+### Added
+
+- CLI CSV export support via `--csv`
+- CLI JSON export support via `--json`
+- Optional statistics file output while preserving the existing console report display
+
+### Changed
+
+- Updated CLI to support saving analysis statistics to CSV and JSON files without changing the existing screen output flow
+
+---
+
+## v0.17.0
+
+### Added
+
+- CLI-enabled road analysis execution
+- Public API entrypoint cleanup for package usage
+- README onboarding updates for Installation, Quick Start, and Python API
+- Improved CLI user-facing error handling
+- CLI input information display
+
+### Changed
+
+- Migrated the codebase to the `src/wrgd` package structure
+- Updated tests to align with the new package layout
+
+---
+
+## [Unreleased]
+
+No unreleased changes.
+
+---
+
+## v0.14.0
+
+### Added
+
+- Road Statistics API (`RoadSegment.statistics()`)
+- Unified road statistics retrieval
+- Added unit test for `statistics()`
+
+### Changed
+
+- Updated Demo application to use the Statistics API
+- Updated CLI to use the Statistics API
+
+---
+
+## [v0.13.0] - 2026-07-26
+
+### Added
+
+- Command Line Interface (CLI)
+- Shared application utilities (`src/app.py`)
+- Elevation profile visualization
+- Demo application improvements
+
+### Improved
+
+- Refactored demo and CLI to share common logic
+- Improved project structure and maintainability
+
+### Quality
+
+- 42 pytest tests passed
+- Ruff passed
+- Black passed
+- mypy passed
+
+---
+
+## [v0.12.0] - 2026-07-26
+
+### Added
+
+- Demo application (`examples/demo.py`)
+- Road analysis report
+- Elevation profile visualization
+- PNG export (`output/elevation_profile.png`)
+
+### Improved
+
+- README updated with demo instructions
+- Demo screenshots and usage examples
+
+### Quality
+
+- 42 pytest tests passed
+- Ruff passed
+- Black passed
+- mypy passed
+
+---
+
+## [v0.11.0] - 2026-07-22
+
+### Added
+
+- GPX elevation (`<ele>`) output support
+- Backward-compatible GPXWriter
+- Unit tests for GPX elevation support
+- Validation for invalid point formats
+
+### Improved
+
+- README updated with GPX elevation examples
+
+### Quality
+
+- 42 pytest tests passed
+- Ruff passed
+- Black passed
+- mypy passed
+
+---
+
+## [v0.10.0] - 2026-07-22
+...
+
+### Added
+
+- GPXWriter implementation
+- GPX 1.1 export support
+- GPXWriter unit tests
+
+### Improved
+
+- README updated
+- Architecture diagram updated
+- Supported formats table added
+
+### Quality
+
+- 39 pytest tests passed
+- Ruff passed
+- Black passed
+- mypy passed
+
+### Known Issues
+
+- When using NumPy 2.5.x, a `DeprecationWarning` may be emitted by the Rasterio dependency when loading DEM files.
+- This warning originates from Rasterio, not WRGD, and does not affect functionality.
+
+---
+
+## [v0.9.0] - 2026-07-20
+
+### Added
+
+- GeoJSONReader
+- GeoJSONWriter
+- GPXReader
+- GeoJSON unit tests
+- GPX unit tests
+
+### Improved
+
+- README
+- API Overview
+
+---
+
+## [v0.8.0] - 2026-07-17
+
+### Added
+
+- Ruff
+- Black
+- mypy
+- pytest-cov
+- CHANGELOG.md
+
+### CI
+
+- Improved GitHub Actions
+
+### Documentation
+
+- README improvements
+
+---
+
+## [v0.7.0] - 2026-07-13
+
+### Added
+
+- ElevationProfile class
+- Cumulative distance calculation
+- Elevation profile generation
+- Maximum / Minimum elevation
+- Total ascent / descent
+
+### CI
+
+- GitHub Actions for automatic pytest execution
+
+### Documentation
+
+- README improvements
+- LICENSE (MIT)
+- CONTRIBUTING.md
+
+---
+
+## [v0.6.0] - 2026-07-12
+
+### Added
+
+- RoadSegmentBuilder
+- Automatic DEM elevation lookup
+- Automatic distance calculation
+- Automatic gradient calculation
+
+---
+
+## [v0.5.0] - Sprint 4
+
+### Added
+
+- RoadSegment class
+- Distance summary
+- Average gradient
+- Validation checks
+
+---
+
+## [v0.4.0] - Sprint 3
+
+### Added
+
+- calculate_distance()
+- calculate_gradient()
+
+---
+
+## [v0.3.0] - Sprint 2
+
+### Added
+
+- DEMLoader
+- GeoTIFF support
+- Elevation lookup
+- Out-of-range validation
+
+---
+
+## [v0.2.0] - Sprint 1
+
+### Added
+
+- DEM dataset research
+- Dataset comparison
+
+---
+
+## [v0.1.0] - Sprint 0
+
+### Added
+
+- Repository creation
+- Development environment
+- pytest setup

wrgd-0.18.0/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+Thank you for your interest in WRGD!
+
+## Development Environment
+
+- Python 3.12
+- pytest
+
+## Running Tests
+
+```bash
+pytest

wrgd-0.18.0/LICENSE

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

wrgd-0.18.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE
+include CONTRIBUTING.md
+include CHANGELOG.md
+include pyproject.toml
+
+recursive-include src *.py
+recursive-include tests *.py
+recursive-include docs *.md