cfdb-vars

variable definitions for cfdb


License
Other
Install
pip install cfdb-vars==0.2.3

Documentation

cfdb-vars

variable definitions for cfdb

build codecov PyPI version


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


Overview

The purpose of this package is to separate the variable metadata from the main cfdb package so that additional variables can be added without updating the version of the cfdb package. This package will have the data model for variables defined in msgspec and the variable data defined in python files (one initially).

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_vars

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.