dac: A CLI Helper Tool for Data as Code

Data as Code (DaC) is a paradigm of distributing versioned data as code.

dac is a tool that supports the Producer.

IMPORTANT: Currently the project is in the initial development phase, this is why releases are marked as 0.z.y. (following semantic versioning 2.0.0: "Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable."). While in this phase, we will denote breaking changes with a minor increase.

Quickstart

You can install dac as a regular python package

python -m pip install dac

Then use the integrated help to find out its functionalities

dac --help

dac pack

This command allows you to build a Data as Code Python package.

If you want to see a usage example, you can have a look at how dac is used to build the dac-example-energy DaC python package here (look at .gitlab-ci.yml).

Consider that there are alternative ways to build a Data as Code package. To know more, consult this page

Setup development environment (for contributors only)

• Create a virtual environment and activate it

  python -m venv venv
  . venv/bin/activate

• Install the developer dependencies

  python -m pip install -U pip wheel setuptools
  python -m pip install -r requirements-dev.txt

• Enable the pre-commits

  pre-commit install

• To run all the tests

  pytest --run-slow

  (omit --run-slow to run only the fast unit tests)