Skip to content

InformaticsMatters/data-manager-file-conversion-jobs

Repository files navigation

data-manager-file-conversion-jobs

pre-commit Code style: black

Data Manager job definitions for file conversions.

Contributing

The project uses pre-commit to enforce rules on files prior to committing them to the upstream repository. You MUST comply with this style to contribute to the project.

To get started review the pre-commit utility and then setup your local clone by following the Installation and Quick Start sections: -

pip install -r build-requirements.txt
pre-commit install

Now the project's pre-commit rules will run on every commit, and you can test everything's OK now with: -

pre-commit run --all-files

Testing

Use the Data Manager Job Tester (jote) to run tests against the job's definition, You will need to build the image first: -

pip install -r build-requirements.txt

docker-compose build
jote

And make sure your code passes pylint: -

pylint src