DKUtils 0.0.1

DataKitchen Utils Library

DKUtils

This python package is intended to house utility functions and classes that are used in DataKitchen recipes.

Building and testing this module is conveniently done using Make. Issue the make command to see a list of available targets (shown below for convenience). Note that any target can be suffixed with -ext to run that target inside a Docker container. This allows testing and development in a standard and portable environment. To develop inside a running docker container, use the bash-ext target. This will drop the user into a bash shell inside a running container.

Add '-ext' to any target to run it inside a docker container

Available commands:
  bump/major bump/minor bump/patch - bump the version
  bash         run bash - typically used in conjunction with -ext to enter a docker container
  lint         run flake8 and yapf
  flake8       run flake8
  yapf         run yapf and correct issues in-place
  yapf-diff    run yapf and display diff between existing code and resolution if in-place is used
  image        build a docker image for service dkcommon
  clean        remove files from last test run (e.g. report_dir, .coverage, etc.) and *.pyc files
  test         compile and run all unit tests
  clean_pyc    remove all *.pyc files
  compile      compile python source files
  clean_unit   remove files from last test run (e.g. report_dir, .coverage, etc.)
  test_unit    run all unit tests

Pre-commit is also included to validate and flag commits that contain code that does not pass Flake8 and YAPF. To use, first install the python package pip install pre-commit and then run pre-commit install. All future commits will run these tools and deny commits that don't pass. When running YAPF, pre-commit will make in-place corrections to your code. Therefore, if it fails the YAPF validation on the first commit attempt, simply review the changed files, add, and commit again to resolve.