augint-library 1.18.0

A template library for Python library projects using Poetry and Semantic Release.

Augmenting Integrations Library Template Repository

---

📚 Project Resources

Resource	Description	Link
📖 Documentation	API documentation and guides	View Docs
🧪 Test Report	Pytest test results and summary	View Tests
📊 Coverage Report	Code coverage analysis	View Coverage
🔒 Security Dashboard	Vulnerability scans and security analysis	View Security
⚖️ License Compliance	License compatibility analysis	View Compatibility

---

Pre-requisites

Install Poetry, AWS CLI, and SAM CLI

Google it and follow the instructions for your platform.

Secret Management

Install chezmoi and age

winget install twpayne.chezmoi
winget install --id FiloSottile.age

Don't forget to setup chezmoi to use age for encryption and github for remote storage.

Set up your AWS OIDC provider (once per account)

Run this once per AWS account (safe to re-run; will no-op if it exists):

aws iam create-open-id-connect-provider `
  --url https://token.actions.githubusercontent.com `
  --client-id-list sts.amazonaws.com

---

⚡ Getting Started

Very important: Grab your PyPi and TestPyPi names right away, they may not be available later!

---

Configure Trusted Publisher on PyPI and TestPyPI

• Go to PyPI Trusted Publishers
• Click Add a trusted publisher, link this repo, and authorize publishing from main
• Repeat on TestPyPI Trusted Publishers for dev

---

Bootstrap your project

Run the bootstrap script to set up your project:

# Complete setup (creates .env and AWS resources)
python bootstrap.py setup

# Or run steps individually:
python bootstrap.py init      # Create .env file
python bootstrap.py aws       # Set up AWS pipeline resources and fix trust policy

The bootstrap script will:

1. Auto-detect your GitHub info from git remote
2. Create a .env file with all required variables
3. Run sam pipeline bootstrap and capture the generated ARNs
4. Automatically fix the trust policy for GitHub Actions OIDC

Manual setup steps

1. Fill in your GitHub token in .env

2. Save your .env file to chezmoi:

   chezmoi add .env
   chezmoi git add .
   chezmoi git commit -- -am "Add .env file for your-repo-name"
   

3. Replace template names:

   • Search and replace augint-library → your project name
   • Search and replace augint_library → your module name
   • Rename directory: src/augint_library → src/<your_module_name>
   • Clear contents of CHANGELOG.md
   • Set version to 0.0.0 in pyproject.toml

4. Initialize development environment:

   poetry install
   poetry lock
   pre-commit install
   pre-commit install --install-hooks
   pre-commit run --all-files
   

5. Push secrets to GitHub:

   ai-gh-push
   

6. Push your repo! Don't for get to set your repository's branch protection rules to require a successful run of the pipeline before merging PRs.

7. To use Claude Code remember to have this in your environment one way or another:

$env:CLAUDE_CODE_GIT_BASH_PATH="C:\Program Files\Git\bin\bash.exe"

📝 Documentation Style Guide

This template uses pdoc for automatic API documentation generation. Follow these patterns for optimal documentation:

Docstring Style: Google Format

def function_name(param1: str, param2: int = 0) -> bool:
    """Brief description of what the function does.

    Longer description if needed. Can span multiple lines
    and include implementation details.

    Args:
        param1: Description of param1.
        param2: Description of param2 (default: 0).

    Returns:
        Description of return value.

    Raises:
        ValueError: Description of when this is raised.

    Example:
        >>> function_name("test", 42)
        True
    """

CLI vs Library Documentation

1. Use __all__ to control API surface

# Only show library functions in docs
__all__ = ["public_function", "AnotherClass"]

2. Module organization

"""Module docstring explaining both library and CLI usage.

Library usage:
    >>> from mymodule import public_function
    >>> public_function("arg")

CLI usage:
    $ my-command arg
"""

3. CLI function documentation

@click.command()
def cli_command():
    """CLI entry point - not for direct import.

    Note:
        This function is excluded from public API.
        Use the installed CLI command instead.
    """

Template Patterns

For CLI-heavy projects:

• Put CLI commands in separate module (e.g., cli/commands.py)
• Use __all__ to hide CLI internals
• Document CLI usage in module docstrings

For library-heavy projects:

• Focus on public API documentation
• Use extensive examples in docstrings
• Group related functions in modules

---

Helpful Commands

# "source" an .env file in PowerShell
get-content .env | foreach {
    $name, $value = $_.split('=')
    if ([string]::IsNullOrWhiteSpace($name) -or $name.Contains('#')) {
        # skip empty or comment line in ENV file
        return
    }
    set-content env:\$name $value
}