Skip to main content

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

Project description

Augmenting Integrations Library Template Repository

CI Status

PyPI Code style: black pre-commit GitHub Actions Conventional Commits semantic-release License Sponsor


📚 Project Resources

📖 Current Documentation 🧪 Test report for last release

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


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_librarysrc/<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"

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
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

augint_library-1.8.0.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

augint_library-1.8.0-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

Details for the file augint_library-1.8.0.tar.gz.

File metadata

  • Download URL: augint_library-1.8.0.tar.gz
  • Upload date:
  • Size: 30.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for augint_library-1.8.0.tar.gz
Algorithm Hash digest
SHA256 dca19eb2868dc05c903595b889778b6af0edfe4a9510425a08742d950e284909
MD5 18928eb2049a4c07dce1ebfe981f49f2
BLAKE2b-256 287adb80690251bfe1cf2bb02320abce81320f316c8974cd84d7282b8d5e44e5

See more details on using hashes here.

Provenance

The following attestation bundles were made for augint_library-1.8.0.tar.gz:

Publisher: pipeline.yaml on svange/augint-library

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file augint_library-1.8.0-py3-none-any.whl.

File metadata

  • Download URL: augint_library-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 28.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for augint_library-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec0c714848c1e4641c570eaf45199b363fde72fad6c9d800d549ca54044b7440
MD5 182f2bd7b45745ba0b25d550644c5860
BLAKE2b-256 14de7c88cfa465e76c7b63cfbf01fa837d5ea9ccc19fbed7f7fd1ef4645f1cf8

See more details on using hashes here.

Provenance

The following attestation bundles were made for augint_library-1.8.0-py3-none-any.whl:

Publisher: pipeline.yaml on svange/augint-library

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page