Skip to main content

coiled

CI TypeScript Coverage PyPI Python 3.14+ License: MIT Code style: ruff

Coiled utils

Installation

Install using pip:

pip install habemus-papadum-coiled

Or using uv:

uv pip install habemus-papadum-coiled

Usage

from pdum import coiled

print(coiled.__version__)

Development

This project uses UV for dependency management.

Setup

# Install UV if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh
# Install pnpm (required for the widgets workspace)
curl -fsSL https://get.pnpm.io/install.sh | sh -

# Clone the repository
git clone https://github.com/habemus-papadum/pdum_coiled.git
cd coiled

# Provision the entire toolchain (uv sync, pnpm install, widget build, pre-commit hooks)
./scripts/setup.sh

Important for Development:

  • ./scripts/setup.sh is idempotent—rerun it after pulling dependency changes
  • Use uv sync --frozen to ensure the lockfile is respected when installing Python deps
  • The widgets live in widgets/ and are managed with pnpm (see "TypeScript widgets" below)

Running Tests

# Run all tests
uv run pytest

# Run a specific test file
uv run pytest tests/test_example.py

# Run a specific test function
uv run pytest tests/test_example.py::test_version

# Run tests with coverage
uv run pytest --cov=src/pdum/coiled --cov-report=xml --cov-report=term

Code Quality

# Check code with ruff
uv run ruff check .

# Format code with ruff
uv run ruff format .

# Fix auto-fixable issues
uv run ruff check --fix .

TypeScript widgets (pnpm)

# Lint the widget source
pnpm lint

# Type-check only the widgets package
pnpm --filter '@habemus-papadum/coiled-widgets' typecheck

# Build the browser bundle and copy it into the Python package
pnpm --filter '@habemus-papadum/coiled-widgets' build:python

# Run Vitest (or add --coverage)
pnpm --filter '@habemus-papadum/coiled-widgets' test

Building

# Build Python + TypeScript artifacts
./scripts/build.sh

# Or build just the Python distribution artifacts
uv build

Releasing

Releases run from the release GitHub Actions workflow, which calls ship:

# Plan first (the default), then release for real
gh workflow run release.yml -f bump=minor -f dry_run=true
gh workflow run release.yml -f bump=minor -f dry_run=false

Each release is tagged habemus-papadum-coiled-v<version> on the commit it was built from. Between releases pyproject.toml carries <last release>+dev; ship sets the release version, builds, tests, publishes to PyPI, tags, and restores the development marker. To see the plan locally:

uv run ship release habemus-papadum-coiled --bump minor --dry-run

The widgets package in widgets/ is private: it is not published to npm, and its built bundle ships inside the Python wheel. Rebuild and commit src/pdum/coiled/widgets/index.js when the widget source changes.

The ship-check pre-commit hook runs ship deps check --hook from the locked environment. pre-commit is in the dev group; ./scripts/setup.sh installs the hooks with uv run pre-commit install.

Automation scripts

  • ./scripts/setup.sh – bootstrap uv, pnpm, widget bundle, and pre-commit hooks
  • ./scripts/build.sh – sync the environment, type-check and build the widget bundle
  • ./scripts/test_notebooks.sh – execute demo notebooks (uses ./scripts/nb.sh under the hood)
  • ./scripts/setup-visual-tests.sh – install Playwright browsers for visual tests

License

MIT License - see LICENSE file for details.

Metadata

Release files for habemus-papadum-coiled 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for habemus-papadum-coiled 0.1.1
File Size Uploaded Provenance Actions
habemus_papadum_coiled-0.1.1.tar.gz 186.3 kB Without provenance Details for habemus_papadum_coiled-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for habemus-papadum-coiled 0.1.1
File Interpreter ABI Platform Actions
habemus_papadum_coiled-0.1.1-py3-none-any.whl Python 3 none any Details for habemus_papadum_coiled-0.1.1-py3-none-any.whl

Total release size: 197.9 kB

Release files / habemus_papadum_coiled-0.1.1.tar.gz

Download URL habemus_papadum_coiled-0.1.1.tar.gz
Size 186.3 kB
Tags Source
SHA-256 checksum
How to use checksums
654e768052ef8cf549d8a2f2bf613c3228efa91418818584b63266006545c365
BLAKE2b-256 checksum
How to use checksums
7b909f8f31cd9c80e7a74d538b6e894952bed0afeb436a8f2048601fc35ce8bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / habemus_papadum_coiled-0.1.1-py3-none-any.whl

Download URL habemus_papadum_coiled-0.1.1-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5a3f3c3e850f58251fca269f12312a9b59361413b834b2e0553656ff4f9431a9
BLAKE2b-256 checksum
How to use checksums
16fd5c65c41c01fc2be386b3d7747d779234faa1dee62adeef2f7dc100c3aacc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for habemus-papadum-coiled 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page