Skip to main content

Compose deployment infrastructure from reusable Terraform-backed blocks.

Project description

freeloader

You have better things to do than deploy the same app for the hundredth time.

freeloader is a Python CLI for composing deployment infrastructure from reusable Terraform-backed blocks. It is built for solo builders and small teams who want a repeatable path from a local project to hosted code, CI, container registry, and deployment targets without re-writing the same glue every weekend.

Python 3.12+ License: MIT

What It Does

Freeloader turns deployment setup into a manifest-driven planning flow:

  1. Detect the project stack.
  2. Inspect available infrastructure blocks.
  3. Check local provider support and required secrets.
  4. Generate a manifest of selected blocks.
  5. Provision or destroy resources through the block execution layer.

Blocks are small Terraform-backed units. A block declares its config, requirements, provided outputs, costs, and assets. The project planner decides which blocks fit the current project and can explain why a block was excluded.

Install

pipx install freeloader

or:

uv tool install freeloader

The CLI entrypoint is:

fl --help

Quick Start

From inside a project directory:

fl project detect
fl project manage --explain
fl project provision

Useful commands:

fl project status
fl secrets ls
fl service-providers --help

Concepts

Project

The project feature owns composition. It detects the tech stack, asks the block catalog for candidates, evaluates provider support and secret availability, and writes the manifest.

Blocks

Blocks are validated Terraform definition units. Each block lives with its block.yml, main.tf, and optional templates. Contracts use shared requires and provides port names documented in docs/BLOCK_PORT_CONTRACTS.md.

Service Providers

Service providers own provider identity, auth, billing checks, and local support checks. Provider capability is reported as structured data so planning can explain unsupported blocks.

Secrets

Secrets are stored behind the secrets feature. Planning only checks key availability; secret values do not leave the secrets boundary.

Development

This project uses Python 3.12+, uv, pytest, ruff, and Hatchling.

uv sync --all-groups
uv run pytest
uv run ruff check

Build locally:

uv run python -m build
uv run twine check dist/*

Releases

The package version is derived from the GitHub release tag. Create tags like:

git tag v0.1.0
git push origin v0.1.0

The release.yml workflow builds the package from the tag and publishes to PyPI with trusted publishing. Configure a PyPI trusted publisher for:

  • Repository: 9orky/freeloader
  • Workflow: release.yml
  • Environment: pypi

Status

Freeloader is pre-1.0 software. Expect the block catalog and planning diagnostics to evolve quickly while the public CLI stabilizes.

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

freeloader-0.1.1.tar.gz (150.1 kB view details)

Uploaded Source

Built Distribution

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

freeloader-0.1.1-py3-none-any.whl (119.6 kB view details)

Uploaded Python 3

File details

Details for the file freeloader-0.1.1.tar.gz.

File metadata

  • Download URL: freeloader-0.1.1.tar.gz
  • Upload date:
  • Size: 150.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for freeloader-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d7d1c8320097360369a0b1b63f13605f5302716458a223d74aebf72819a06593
MD5 88611b781fc28937c36c26bc198a0118
BLAKE2b-256 90326559bc884507507564ab3e6d2003f62cd4d4ebd6dd2cb507bcbe5860ccd5

See more details on using hashes here.

Provenance

The following attestation bundles were made for freeloader-0.1.1.tar.gz:

Publisher: release.yml on 9orky/freeloader

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

File details

Details for the file freeloader-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: freeloader-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 119.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for freeloader-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 971e2b11f6e5dfec33b8bc5370c5980082d1d74bad0a7c246719f6bf57a6c640
MD5 1063a75f470fa679dbbeb33fe17dca00
BLAKE2b-256 841c4d14e17005d71a5fc3e1aff7037dca421e804f68fc7abc79a49cd87e491a

See more details on using hashes here.

Provenance

The following attestation bundles were made for freeloader-0.1.1-py3-none-any.whl:

Publisher: release.yml on 9orky/freeloader

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