Skip to content

Cosmo Data Update Quest Documentation

Welcome to the Cosmo Data Update Quest (CosmoDUQ) documentation. This tool provides a framework for migrating between different versions of Cosmo-Tech APIs.

Overview

CosmoDUQ is designed to help users and developers manage API version transitions in the Cosmo Tech ecosystem. It provides tools and utilities to ensure smooth data migration between different API versions.

Getting Started

Installation

  1. Ensure you have Python 3.11 or higher installed
  2. Create a virtual environment: 
    python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
  3. Install the package: 
    pip install -e .[all]

Development Environment

Code Quality Tools

  1. Black Configuration
  2. The project uses Black for code formatting
  3. Configuration in pyproject.toml: 
    [tool.black]
line-length = 120
target-version = ["py311"]

  4. Files are automatically formatted on commit

  5. Pre-commit Hooks

  6. Install hooks: pre-commit install
  7. Configured hooks:
    • trailing-whitespace
    • end-of-file-fixer
    • check-added-large-files
    • black
  8. Run manually: pre-commit run --all-files

Documentation

This documentation is built using MkDocs with the Material theme and several extensions: - Material theme with light/dark mode - Code syntax highlighting - Table of contents generation - Admonitions and content tabs - Automatic versioning with mike

To build documentation locally: 

pip install -e .[doc]
mkdocs serve

Project Structure

  • /cosmotech/data_update_quest/: Core migration framework
  • /docs/migrations/: Version-specific migration guides
  • /docs/notes/: Technical notes and analysis
  • /tests/: Test suite (coming soon)

Next Steps