Changelog
All notable changes to the MTNA RDS Toolkit will be documented here.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[Unreleased]
Added
Comprehensive Sphinx documentation
Installation guide with uv and pip instructions
Quick start guide with examples
Detailed API reference
Contributing guidelines
Changed
Improved README with comprehensive project information
Enhanced documentation structure
Removed MCP server references (now maintained in a separate package)
[0.0.1] - 2024
Initial Release
Added
Core RDS server connectivity
Catalog and data product browsing
Variable metadata access
Croissant metadata generation
DCAT/RDF export functionality
Type-safe Pydantic models
HTML to Markdown conversion
Comprehensive test suite
CI/CD with GitHub Actions
Core Features
MtnaRdsServer: Client connection to MTNA RDS API endpoints
MtnaRdsCatalog: Catalog browsing and management
MtnaRdsDataProduct: Dataset metadata and variable access
MtnaRdsVariable: Variable inspection with classification support
DCAT Export: RDF graph generation for semantic web
Croissant Export: ML-ready dataset documentation
Dependencies
Python 3.12+ support
Pydantic 2.0+ for data modeling
RDFLib 7.0+ for RDF graphs
mlcroissant 1.0+ for Croissant metadata
markdownify for HTML conversion
Development Tools
Ruff for linting and formatting
pytest for testing
mypy for type checking
pre-commit hooks
Sphinx for documentation
GitHub Actions CI/CD
Known Limitations
Documentation is still being expanded
Data querying and aggregation features are planned
PyPI package not yet published
Migration Guide
This section will be populated when there are breaking changes between versions.
Future Plans
Planned for 0.1.0
Data querying and subsetting functionality
Tabulation and aggregation tools
Enhanced caching strategies
Additional metadata format support
First PyPI release
Planned for 0.2.0
Performance optimizations
Advanced query capabilities
Additional export formats
Plugin system for extensibility
Enhanced error handling and recovery
Long-term Roadmap
Data visualization integration
Streaming data support
Batch processing utilities
Additional AI assistant integrations
Web UI for dataset exploration
Deprecation Notices
No deprecations in current version.
Security Updates
This project follows responsible security disclosure practices. Security vulnerabilities will be documented here once fixed.
How to Upgrade
Since the package is not yet on PyPI, upgrade by pulling the latest changes:
cd mtnards-toolkit
git pull origin main
uv sync # or pip install -e .
For future PyPI releases:
pip install --upgrade dartfx-mtnards
Version History
0.0.1 (2024) - Initial development release
Contributors
Pascal L.G.A. Heus - Initial work and maintainer
See the GitHub contributors page for a full list of contributors.