Skip to main content

A small, opinionated uv-native Python monorepo framework.

Project description

Joist

A tiny, opinionated Python monorepo framework built around uv.

Joist borrows a few proven ideas from Nx and Lerna without trying to become their Python clone:

  • a project graph built from workspace packages
  • named targets such as test, lint, and build
  • dependency-aware task ordering
  • affected-project runs based on git diff
  • a small local task cache
  • fixed-version releases for public packages

Quickstart

uvx joist init demo
cd demo
uvx joist new lib core
uvx joist new app api --depends-on core
uvx joist graph
uvx joist run test --all
uvx joist affected test --base main
uvx joist version patch --dry-run

This creates a uv workspace with one library, one app, an editable internal workspace dependency from api to core, and graph-aware Joist targets.

If Joist is installed in the current environment, the console command is available directly:

joist list
joist affected test --base origin/main --head HEAD

Python support

Joist supports Python 3.11 through 3.14. The minimum is Python 3.11 because Joist uses the standard-library tomllib module for TOML parsing.

Opinionated layout

joist init creates this shape:

.
|-- apps/
|-- packages/
|-- joist.toml
`-- pyproject.toml

Projects live in apps/* or packages/*, each with its own pyproject.toml. The root pyproject.toml owns the uv workspace; Joist treats that as the package source of truth whenever possible. Joist uses uv workspace membership to discover packages, uv workspace sources to keep internal dependencies editable, and uv commands to sync, test, build, and publish. Joist only adds graph-aware task orchestration on top:

[tool.uv]
package = false

[tool.uv.workspace]
members = ["packages/*", "apps/*"]

Configuration

joist.toml defines project globs and target defaults:

[workspace]
projects = ["packages/*", "apps/*"]
default_base = "main"
cache_dir = ".joist/cache"

[target_defaults.test]
command = "uv run --package {package_name} pytest {project_root}/tests"
cache = true
inputs = ["{project_root}/src/**/*.py", "{project_root}/tests/**/*.py", "{project_root}/pyproject.toml", "pyproject.toml", "uv.lock"]

[target_defaults.build]
command = "uv build --package {package_name}"
cache = false
depends_on = ["^build"]

Target command templates support:

  • {workspace_root}
  • {project_root}
  • {project_name}
  • {package_name}

Commands are split with Python's shlex and executed without a shell. Use an explicit shell command such as sh -c "..." only when shell syntax is required.

Each project can override or add targets in its own pyproject.toml:

[tool.joist]
name = "api"
type = "app"
depends_on = ["core"]

[tool.joist.targets.serve]
command = "uv run --package api python -m api"
cache = false

Internal dependencies are inferred from [project].dependencies when a dependency name matches another workspace package. In uv, workspace-member dependencies should also be declared with tool.uv.sources:

[project]
dependencies = ["core==0.1.0"]

[tool.uv.sources]
core = { workspace = true }

Explicit depends_on is available for task-ordering edges that are not package dependencies.

Affected run flow

joist affected follows the same broad shape as Nx affected runs: Git decides which files changed, Joist maps those files onto workspace projects, then the project graph pulls in dependents that also need validation.

flowchart TD
    A["git diff chooses changed files"] --> B["Map files to project roots"]
    B --> C{"Root coordination file changed?"}
    C -- "yes" --> D["Select every project"]
    C -- "no" --> E["Select directly changed projects"]
    E --> F["Add reverse dependents"]
    D --> G["Topologically sort selected projects"]
    F --> G
    G --> H["Expand target pipelines, such as ^build"]
    H --> I{"Cache hit?"}
    I -- "yes" --> J["Replay cached output"]
    I -- "no" --> K["Run rendered uv command"]
    K --> L["Record successful output in local cache"]

Root coordination files currently include:

joist.toml
pyproject.toml
uv.lock

Commands

uv run python -m joist list
uv run python -m joist graph --format dot
uv run python -m joist run build api
uv run python -m joist run lint --all --dry-run
uv run python -m joist affected test --base origin/main --head HEAD
uv run python -m joist cache clear
uv run python -m joist version minor

depends_on = ["^build"] means "run the build target for dependency projects before this project." This is the one Nx-style target pipeline rule Joist supports.

The cache is deliberately simple. It hashes configured input files, the rendered command, and extra CLI args, then replays cached terminal output for successful runs. It does not implement remote cache or artifact restoration, so generated build targets are intentionally uncached by default.

Build system integration

Treat joist.toml targets as the contract between the monorepo and your build system. Keep the target commands uv-native, then have CI or local automation call Joist to decide which projects need each target.

For pull requests, fetch enough Git history for the base comparison and run only affected targets:

name: ci

on:
  pull_request:

jobs:
  affected:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: astral-sh/setup-uv@v5
      - run: uv sync --locked
      - run: uv run python -m joist affected lint --base origin/${{ github.base_ref }} --head HEAD
      - run: uv run python -m joist affected test --base origin/${{ github.base_ref }} --head HEAD
      - run: uv run python -m joist affected build --base origin/${{ github.base_ref }} --head HEAD

For main-branch validation or nightly builds, run the complete target set:

name: full-build

on:
  push:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: astral-sh/setup-uv@v5
      - run: uv sync --locked
      - run: uv run python -m joist run lint --all
      - run: uv run python -m joist run test --all
      - run: uv run python -m joist run build --all

For Make-based workflows, delegate the selection logic to Joist instead of duplicating package lists:

.PHONY: lint test build affected-test clean-cache

lint:
	uv run python -m joist run lint --all

test:
	uv run python -m joist run test --all

build:
	uv run python -m joist run build --all

affected-test:
	uv run python -m joist affected test --base origin/main

clean-cache:
	uv run python -m joist cache clear

For release pipelines, keep versioning explicit and build every public package after the bump:

uv sync --locked
uv run python -m joist version patch
uv lock
uv run python -m joist run build --all --no-cache

Before uploading, run the local PyPI readiness checks:

uv run pytest
uv run ruff check .
uv build
uv run twine check dist/*
uv publish --dry-run --trusted-publishing never

Joist does not publish packages for you. Keep publishing as a separate, auditable step using the uv command and credentials your release system already controls.

For public PyPI publishing, verify the distribution name immediately before the first upload.

Release model

Joist uses one Lerna-inspired release mode: fixed versions. joist version patch bumps every non-private workspace project to the same version and writes a root VERSION file. Internal dependency pins that point at public workspace packages are updated too, including pins in private projects.

Mark private projects with:

[tool.joist]
private = true

Design boundaries

Joist is intentionally not a plugin ecosystem, not a remote cache service, and not a Python package publisher. uv owns workspace membership, locking, syncing, editable internal dependencies, building, and publishing. Joist is a small task orchestration layer over uv, git, and project-local commands.

License

Joist is licensed under the Universal Permissive License 1.0 (UPL-1.0).

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

joist-0.1.0.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

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

joist-0.1.0-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file joist-0.1.0.tar.gz.

File metadata

  • Download URL: joist-0.1.0.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for joist-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ea4c682cf960ca946e69819a1e91c0d5312ddc130005fc9e4073a676ef115b0f
MD5 b3478b298bd327a35144a16da9292ef4
BLAKE2b-256 b243f983dcfd14be7eb655be82dec13576e73901b9c3c6b8c7e1e6abcc0f4d65

See more details on using hashes here.

File details

Details for the file joist-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: joist-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for joist-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 72361e9058cb8da7addda841f2f00f3f6ec29aa79f3d5c1de3a967f580a166fa
MD5 bb8e2ce5dc2ffb538dfb8e5ca013e78d
BLAKE2b-256 c93ab6a783dd644f883beee5b99da9cac7b540d2da4d06f2230784c58675df15

See more details on using hashes here.

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