|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to this project will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | +### Added |
| 11 | +- Comprehensive README with installation, usage, and examples |
| 12 | +- CONTRIBUTING.md with development guidelines |
| 13 | +- Complete example documentation in docs/usage/ |
| 14 | +- pytest configuration with coverage reporting |
| 15 | +- GitHub Actions CI/CD workflow |
| 16 | +- Additional test files for data models and exceptions |
| 17 | +- Enhanced docstrings for utility functions |
| 18 | +- Support for multiple test markers (slow, integration, unit) |
| 19 | +- **MCP Server** - Model Context Protocol server for AI assistant integration |
| 20 | + - 7 MCP tools: fetch_parcels, cluster_parcels, create_graph, add_node, add_edge, query_graph, list_resources |
| 21 | + - State management with optional file persistence |
| 22 | + - Comprehensive MCP server documentation (docs/MCP_SERVER.md) |
| 23 | + - Example client script demonstrating all tools |
| 24 | + - Claude Desktop configuration example |
| 25 | + - CLI entry point: `shift-mcp-server` |
| 26 | + - 15+ unit tests for MCP functionality |
| 27 | +- API Quick Reference guide (docs/API_REFERENCE.md) |
| 28 | +- QUICKSTART.md for new developers |
| 29 | + |
| 30 | +### Changed |
| 31 | +- Updated pyproject.toml with pytest and coverage configurations |
| 32 | +- Enhanced documentation structure in docs/usage/index.md |
| 33 | +- Improved test coverage for graph operations |
| 34 | +- Added MCP dependencies as optional install: `pip install -e ".[mcp]"` |
| 35 | +- Added loguru as core dependency for logging |
| 36 | + |
| 37 | +### Fixed |
| 38 | +- Fixed exception test imports to match actual exception hierarchy |
| 39 | +- Fixed test filter functions to match correct signatures |
| 40 | +- Added missing Distance import in EdgeModel tests |
| 41 | + |
| 42 | +### Known Issues |
| 43 | +- MCP server has pydantic version conflict with grid-data-models (MCP requires 2.12.x, GDM requires 2.10.x) |
| 44 | + |
| 45 | +## [0.6.1] - 2026-01-29 |
| 46 | + |
| 47 | +### Changed |
| 48 | +- Updated dependencies to support Python 3.10+ |
| 49 | +- Improved error handling in graph operations |
| 50 | + |
| 51 | +## [0.6.0] - Previous Release |
| 52 | + |
| 53 | +### Added |
| 54 | +- Initial public release |
| 55 | +- Core distribution graph functionality |
| 56 | +- OpenStreetMap integration |
| 57 | +- Phase and voltage mapping |
| 58 | +- Equipment mapping |
| 59 | +- Distribution system builder |
| 60 | + |
| 61 | +[Unreleased]: https://github.com/NREL-Distribution-Suites/shift/compare/v0.6.1...HEAD |
| 62 | +[0.6.1]: https://github.com/NREL-Distribution-Suites/shift/compare/v0.6.0...v0.6.1 |
| 63 | +[0.6.0]: https://github.com/NREL-Distribution-Suites/shift/releases/tag/v0.6.0 |
0 commit comments