cfdb-models

data models for cfdb

Source Code: https://github.com/mullenkamp/cfdb-models

Overview

This package is meant to fully define the data model of cfdb using msgspec. This has been separated from the core cfdb package to abstract away the engine implementation from the data model. This will help in defining and assigning attribute templates for things like variables (e.g. cfdb-vars).

Development

Setup environment

We use UV to manage the development environment and production build.

uv sync

Run unit tests

You can run all the tests with:

uv run pytest

Format the code

Execute the following commands to apply linting and check typing:

uv run ruff check .
uv run black --check --diff .
uv run mypy --install-types --non-interactive cfdb_models

To auto-format:

uv run black .
uv run ruff check --fix .

License

This project is licensed under the terms of the Apache Software License 2.0.