MTNA Rich Data Services Toolkit

User Guide

  • Installation
    • Requirements
    • PyPI Release
    • Local Development Installation
      • Using uv (Recommended)
      • Using pip
    • Optional Dependencies
      • MCP Server (Separate Package)
      • Development Tools
      • Documentation Build Tools
    • Verification
    • Configuration
      • Environment Variables
    • Troubleshooting
      • Import Errors
      • SSL Certificate Issues
    • Next Steps
  • Quick Start Guide
    • Prerequisites
    • Basic Workflow
      • Step 1: Connect to an RDS Server
      • Step 2: Browse Catalogs
      • Step 3: Explore Data Products
      • Step 4: Work with Variables
      • Working with Classifications
    • Common Use Cases
      • Generate Croissant Metadata
      • Export DCAT/RDF
      • Generate Markdown Documentation
    • Complete Example
    • Error Handling
    • Next Steps
  • Examples
    • Working with Multiple Catalogs
    • Batch Processing Data Products
    • Working with Variable Types
    • Exporting Variables to CSV
    • Working with Classifications
    • Generating Documentation for Multiple Datasets
    • Creating a Dataset Catalog Index
    • Working with RDF Graphs
    • Caching and Performance
    • Error Handling Best Practices
    • Integration with Pandas
    • More Examples

API Reference

  • Core API Reference
    • Server Connection
      • MtnaRdsServer
        • MtnaRdsServer.model_config
        • MtnaRdsServer.host
        • MtnaRdsServer.base_path
        • MtnaRdsServer.api_path
        • MtnaRdsServer.api_key
        • MtnaRdsServer.ssl_verify
        • MtnaRdsServer.ensure_https_host()
        • MtnaRdsServer.api_endpoint
        • MtnaRdsServer.catalogs
        • MtnaRdsServer.refresh_catalogs()
        • MtnaRdsServer.base_url
        • MtnaRdsServer.api_url
        • MtnaRdsServer.hostname
        • MtnaRdsServer.info
        • MtnaRdsServer.explorer_url
        • MtnaRdsServer.tabengine_url
        • MtnaRdsServer.api_request()
        • MtnaRdsServer.create_catalog()
        • MtnaRdsServer.delete_catalog()
        • MtnaRdsServer.delete_data_product()
        • MtnaRdsServer.get_catalog_by_uri()
        • MtnaRdsServer.get_catalog_by_id()
        • MtnaRdsServer.get_ddi_codebook()
        • MtnaRdsServer.get_import_configuration()
        • MtnaRdsServer.get_info()
        • MtnaRdsServer.get_postman_collection()
        • MtnaRdsServer.get_process_details()
        • MtnaRdsServer.import_file()
        • MtnaRdsServer.is_up()
        • MtnaRdsServer.upload_file()
        • MtnaRdsServer.wait_for_process()
        • MtnaRdsServer.model_post_init()
      • MtnaRdsServerInfo
        • MtnaRdsServerInfo.name
        • MtnaRdsServerInfo.released
        • MtnaRdsServerInfo.version
        • MtnaRdsServerInfo.model_config
    • Catalog
      • MtnaRdsCatalog
        • MtnaRdsCatalog.last_update
        • MtnaRdsCatalog.is_private
        • MtnaRdsCatalog.data_products
        • MtnaRdsCatalog.attach_catalog_to_products()
        • MtnaRdsCatalog.get_data_product_by_uri()
        • MtnaRdsCatalog.get_data_product_by_id()
        • MtnaRdsCatalog.data_products_by_id
        • MtnaRdsCatalog.get_ddi_codebook()
        • MtnaRdsCatalog.get_import_configuration()
        • MtnaRdsCatalog.create_sql_data_product()
        • MtnaRdsCatalog.delete()
        • MtnaRdsCatalog.delete_data_product()
        • MtnaRdsCatalog.get_postman_collection()
        • MtnaRdsCatalog.model_config
        • MtnaRdsCatalog.model_post_init()
    • Data Product
      • MtnaRdsDataProduct
        • MtnaRdsDataProduct.abbreviation
        • MtnaRdsDataProduct.cached
        • MtnaRdsDataProduct.doi
        • MtnaRdsDataProduct.change_log
        • MtnaRdsDataProduct.citation
        • MtnaRdsDataProduct.data_product_type
        • MtnaRdsDataProduct.is_private
        • MtnaRdsDataProduct.keywords
        • MtnaRdsDataProduct.last_update
        • MtnaRdsDataProduct.provenance
        • MtnaRdsDataProduct.urls
        • MtnaRdsDataProduct.api_documentation_url
        • MtnaRdsDataProduct.catalog_id
        • MtnaRdsDataProduct.catalog_uri
        • MtnaRdsDataProduct.classifications
        • MtnaRdsDataProduct.count_api_url
        • MtnaRdsDataProduct.csv_download_url
        • MtnaRdsDataProduct.explorer_url
        • MtnaRdsDataProduct.code_generators_api_url
        • MtnaRdsDataProduct.metadata_api_url
        • MtnaRdsDataProduct.parquet_download_url
        • MtnaRdsDataProduct.regression_api_url
        • MtnaRdsDataProduct.select_api_url
        • MtnaRdsDataProduct.tabulate_api_url
        • MtnaRdsDataProduct.tabengine_url
        • MtnaRdsDataProduct.variables
        • MtnaRdsDataProduct.variables_count
        • MtnaRdsDataProduct.delete()
        • MtnaRdsDataProduct.get_classification_by_uri()
        • MtnaRdsDataProduct.get_classification_by_id()
        • MtnaRdsDataProduct.get_classification_variables()
        • MtnaRdsDataProduct.get_croissant()
        • MtnaRdsDataProduct.get_ddi_codebook()
        • MtnaRdsDataProduct.get_import_configuration()
        • MtnaRdsDataProduct.get_markdown()
        • MtnaRdsDataProduct.get_postman_collection()
        • MtnaRdsDataProduct.get_variable_by_uri()
        • MtnaRdsDataProduct.get_variable_by_id()
        • MtnaRdsDataProduct.load_metadata()
        • MtnaRdsDataProduct.resolve_classifications()
        • MtnaRdsDataProduct.resolve_variables()
        • MtnaRdsDataProduct.model_config
        • MtnaRdsDataProduct.model_post_init()
    • Variable
      • MtnaRdsVariableStub
        • MtnaRdsVariableStub.classification_id
        • MtnaRdsVariableStub.classification_uri
        • MtnaRdsVariableStub.data_type
        • MtnaRdsVariableStub.is_dimension
        • MtnaRdsVariableStub.is_measure
        • MtnaRdsVariableStub.is_required
        • MtnaRdsVariableStub.is_weight
        • MtnaRdsVariableStub.label
        • MtnaRdsVariableStub.last_update
        • MtnaRdsVariableStub.storage_type
        • MtnaRdsVariableStub.croissant_data_type
        • MtnaRdsVariableStub.catalog_id
        • MtnaRdsVariableStub.catalog_uri
        • MtnaRdsVariableStub.classification
        • MtnaRdsVariableStub.data_product_id
        • MtnaRdsVariableStub.data_product_uri
        • MtnaRdsVariableStub.is_stub
        • MtnaRdsVariableStub.resolve()
        • MtnaRdsVariableStub.model_config
        • MtnaRdsVariableStub.model_post_init()
      • MtnaRdsVariable
        • MtnaRdsVariable.decimals
        • MtnaRdsVariable.end_position
        • MtnaRdsVariable.fixed_storage_width
        • MtnaRdsVariable.format
        • MtnaRdsVariable.index
        • MtnaRdsVariable.start_position
        • MtnaRdsVariable.resolve()
        • MtnaRdsVariable.model_config
        • MtnaRdsVariable.model_post_init()
    • Classification
      • MtnaRdsClassificationStub
        • MtnaRdsClassificationStub.reference
        • MtnaRdsClassificationStub.revision_number
        • MtnaRdsClassificationStub.code_count
        • MtnaRdsClassificationStub.codes
        • MtnaRdsClassificationStub.is_stub
        • MtnaRdsClassificationStub.resolve()
        • MtnaRdsClassificationStub.model_config
        • MtnaRdsClassificationStub.model_post_init()
      • MtnaRdsClassification
        • MtnaRdsClassification.is_private
        • MtnaRdsClassification.keyword_count
        • MtnaRdsClassification.last_update
        • MtnaRdsClassification.level_count
        • MtnaRdsClassification.resolve()
        • MtnaRdsClassification.model_config
        • MtnaRdsClassification.model_post_init()
      • MtnaRdsClassificationCode
        • MtnaRdsClassificationCode.id
        • MtnaRdsClassificationCode.code_value
        • MtnaRdsClassificationCode.is_private
        • MtnaRdsClassificationCode.reference
        • MtnaRdsClassificationCode.model_config
        • MtnaRdsClassificationCode.model_post_init()
    • Process
      • MtnaRdsProcess
        • MtnaRdsProcess.model_config
        • MtnaRdsProcess.server
        • MtnaRdsProcess.completed
        • MtnaRdsProcess.id
        • MtnaRdsProcess.failure
        • MtnaRdsProcess.method_id
        • MtnaRdsProcess.method_name
        • MtnaRdsProcess.resource_name
        • MtnaRdsProcess.resource_uri
        • MtnaRdsProcess.status
        • MtnaRdsProcess.completion_details
        • MtnaRdsProcess.completed_successfully
        • MtnaRdsProcess.failed
        • MtnaRdsProcess.in_progress
    • Base Classes
      • MtnaRdsResource
        • MtnaRdsResource.model_config
        • MtnaRdsResource.uri
        • MtnaRdsResource.id
        • MtnaRdsResource.name
        • MtnaRdsResource.description
        • MtnaRdsResource.reference
        • MtnaRdsResource.revision_number
        • MtnaRdsResource.__eq__()
        • MtnaRdsResource.__hash__()
    • Type Definitions
  • DCAT/RDF API Reference
    • Overview
    • Main Class
      • MtnaRdsDcat
        • MtnaRdsDcat.__init__()
        • MtnaRdsDcat.server
        • MtnaRdsDcat.uri_style
        • MtnaRdsDcat.catalogs
        • MtnaRdsDcat.datasets
        • MtnaRdsDcat.graph()
        • MtnaRdsDcat.get_prefixes_ttl()
        • MtnaRdsDcat.add_catalog()
        • MtnaRdsDcat.add_catalogs()
        • MtnaRdsDcat.add_dataset()
        • MtnaRdsDcat.add_datasets()
        • MtnaRdsDcat.get_graph()
    • URI Styles
    • Example Usage
      • Basic RDF Generation
      • Different Output Formats
      • Querying RDF Graphs
    • RDF Namespaces
    • DCAT Classes Used
    • Properties
    • Integration with RDFLib
    • Best Practices
      • Choosing URI Styles
      • Performance Considerations
      • Validation
    • Related Standards

Development

  • Contributing
    • Getting Started
      • Development Setup
    • Development Workflow
      • Creating a Feature Branch
      • Making Changes
    • Coding Standards
      • Python Style
      • Type Hints
      • Docstrings
      • Prefer pathlib
      • Use Pydantic for Models
    • Testing
      • Writing Tests
      • Running Tests
    • Code Quality
      • Linting and Formatting
      • Type Checking
      • Pre-commit Hooks
    • Documentation
      • Building Documentation
      • Documentation Style
    • Submitting Changes
      • Pull Request Process
      • Pull Request Checklist
      • Commit Messages
    • Issue Reporting
      • Bug Reports
      • Feature Requests
    • Code Review
      • What to Expect
      • Responding to Feedback
    • Release Process
      • Version Numbering
    • Community Guidelines
      • Code of Conduct
      • Communication
    • Getting Help
    • Questions?
  • Changelog
    • [Unreleased]
      • Added
      • Changed
    • [0.0.1] - 2024
      • Initial Release
      • Added
      • Core Features
      • Dependencies
      • Development Tools
      • Known Limitations
    • Migration Guide
    • Future Plans
      • Planned for 0.1.0
      • Planned for 0.2.0
      • Long-term Roadmap
    • Deprecation Notices
    • Security Updates
    • How to Upgrade
    • Version History
    • Contributors
    • Links
MTNA Rich Data Services Toolkit
  • Search

© Copyright 2024-2026, Pascal L.G.A. Heus.

Built with Sphinx using a theme provided by Read the Docs.