Introduction

The foundational utilities for PMS integration projects.

Build

1. Create virtual environment (with python > 3.12)

2. make build output directory mkdir target

3. Install project locally (for development) python3 -m pip install -e .[test,dev]

4. Run code linting (static code analysis) python3 -m flake8 --format=html --htmldir=reports/flake8

5. Run unit test python3 -m pytest

6. Or run unit test with coverage python3 -m pytest --cov

7. Package Source and Wheel distributions:

   python3 -c "import shutil, os;shutil.rmtree('target/dist', True);os.makedirs('target', exist_ok=True)"

   python3 -m build -n --wheel -o target/dist "-C--build-option=--build-number=1"

8. [Optional] Source Distribution

   python3 -m build -n --sdist -o target/dist "-C=--build-option="

9. Upload artifacts python3 -m twine upload target/dist/*.whl --verbose

CI/CD

We need to publish the html/json report of static code analysis, unit test cases and coverage reports.