Fixes #59

Proposed Changes

This change introduces

• sagemaker-rightline console script
• A pre-commit hook running the CLI script
• Improved ReadTheDocs setup & added documentation for CLI script and pre-commit hook

Console Script

The console script accepts a path to a py file that holds a get_configuration function. This function is expected to return a sagemaker_rightline.model.Configuration object. The configuration is then run and exits with 0 if all contained Validation objects show success=True and exits with 1 if at least one shows success=False.

Example usage:

General example:

pip install sagemaker-rightline
cd <your-project-directory>
sagemaker-rightline --configuration <relative-path-to-file-containing-get-configuration-function>.py

Try it out in the context of the sagemaker-rightline project example:

git clone git@github.com:stiebels/sagemaker-rightline.git
cd sagemaker-rightline
pip install -e .
cd sagemaker_rightline/examples/sm_pipeline_project
sagemaker-rightline --configuration sm_rightline_config.py

Pre-Commit hook

The pre-commit hook sagemaker-rightline runs the CLI script to validate your Configuration at git commit. Never commit a faulty pipeline again!

Using the pre-commit hook

repos:
- repo: https://github.com/stiebels/sagemaker-rightline@main
  hooks:
  - id: sagemaker-rightline
    name: sagemaker-rightline
    entry: sagemaker-rightline
    language: system
    types: [python]
    pass_filenames: false
    args: ['--configuration', '<relative-path-to-file-containing-get-configuration-function>.py']

ToDo's

• Add documentation for the CLI script
• Add documentation for the pre-commit hook

Maintenance

• Updated tests
• Updated documentation