This directory contains utility scripts for maintaining the BambooHR API Python SDK.

Purpose: Runs the full post-generation pipeline after openapi-generator outputs to the project root.

The generator runs with default output (project root), placing package code at bamboohr_sdk/, docs at docs/, etc. This script handles cleanup and processing after generation.

Steps:

1. Cleans up unwanted generator artifacts (.gitlab-ci.yml, .github/, etc.)
2. Removes PublicAPIApi files and references (internal-only API)
3. Formats generated code with ruff
4. Adds custom headers to API documentation
5. Cleans up obsolete files (compares old vs new FILES manifest)

Usage: Called automatically by make generate. Not typically run manually.

python scripts/post_generate.py

Purpose: Removes files that are no longer generated by the OpenAPI Generator.

How it works:

1. Before generation, the Makefile backs up .openapi-generator/FILES to .openapi-generator/FILES.old
2. After generation, this script compares the old and new FILES manifests
3. Files in the old manifest but not the new one are considered obsolete
4. The script prompts for confirmation before deleting (unless --force is used)
5. Empty directories are cleaned up automatically

Usage:

# Automatic (runs as part of make generate with --force)
make generate

# Manual with confirmation prompt
make cleanup-obsolete
# or directly:
python scripts/cleanup_obsolete_files.py

# Force mode (no confirmation, for CI/unattended runs)
python scripts/cleanup_obsolete_files.py --force

First Run: On the first run there will be no .openapi-generator/FILES.old backup, so the script will skip cleanup. This is expected. Subsequent runs will properly detect and remove obsolete files.

Purpose: Generates the specific exception classes in bamboohr_sdk/exceptions.py from the ERROR_MESSAGES catalog defined in bamboohr_sdk/api_error_helper.py.

Usage: Called automatically by make generate (via post_generate.py). Can also be run manually:

python scripts/generate_exceptions.py

Purpose: Generates exception documentation in docs/Exceptions/ from the error catalog and mustache templates in templates-python/.

Generates:

• docs/Exceptions/Exceptions.md — index of all exception classes
• docs/Exceptions/Classes/<Name>Exception.md — per-exception docs with causes and tips
• docs/Exceptions/Classes/ApiException.md — base exception documentation
• docs/Exceptions/Classes/ClientException.md — client exception base documentation
• docs/Exceptions/Classes/ServerException.md — server exception base documentation

Templates used (from templates-python/):

• error_codes_doc.mustache — index page template
• exception_doc.mustache — per-exception page template
• api_exception_doc.mustache — ApiException page template
• client_exception_doc.mustache — ClientException page template
• server_exception_doc.mustache — ServerException page template

Usage: Called automatically by make generate (via post_generate.py). Can also be run manually:

python scripts/generate_error_docs.py

Dependency: Requires chevron (Mustache renderer). Installed automatically with pip install -e ".[dev]".

Purpose: Orchestrates both exception generation scripts in the correct order:

1. generate_exceptions.py — updates exception classes in bamboohr_sdk/exceptions.py
2. generate_error_docs.py — generates documentation in docs/Exceptions/

Usage: Called automatically by make generate (via post_generate.py). Can also be run manually:

python scripts/update_error_docs.py
# or
make generate-error-docs

Reference: PHP SDK scripts/update_error_docs.sh