/dicom-utils

Collection of utilites for inspecting DICOM files from the command line

Primary LanguageMakefileApache License 2.0Apache-2.0

Python Template

Template repository for Python projects.

Usage

  1. Rename project to the desired project name
  2. Update the $PROJECT variable in Makefile to match step 1
  3. Update install_requires in setup.py with project dependencies
  4. Add source code to the renamed project folder
  5. Run make venv to install the project to a virtual environment
  6. Run the script using venv/bin/python

Optional steps

  • Setup CI - a template CircleCI config is provided in .circeci/config.yml
  • Create Makefile.config - secrets or per-user configuration can go here. Template Makefile.config.example is under version control, but Makefile.config is in .gitignore. Add $(CONFIG_FILE) as a make dependencies for recipes that need vars from Makefile.config

Misc

  • Run make help to get a partial list of available make recipes
  • A pytest mark, ci_skip, is provided to mark tests that should be skipped during CI pipelines