Skip to main content

Create a new Pixeltable project in one command

Project description

pixeltable-new

Create a new Pixeltable project in one command.

Package version Supported Python versions

How to use

Install uv following their guide for your system.

Run:

uvx pixeltable-new myapp

This will create a new project myapp with a Pixeltable schema and declarative serving config.

Enter the directory:

cd myapp

Install dependencies and run:

uv add pixeltable
uv run pxt serve my-service

Open your browser and go to http://localhost:8000/docs to see your API docs.

Application Templates

Vertical apps that each build on a structural pattern — so you already know how to run and deploy them:

uvx pixeltable-new --template multimodal-rag my-kb        # serving + backend (web UI)
uvx pixeltable-new --template video-intel my-video-app    # serving (pure declarative)
uvx pixeltable-new --template agent my-agent              # serving + backend (web UI)
uvx pixeltable-new --template audio-intel my-podcast-app  # serving + backend (web UI)
uvx pixeltable-new --template content-pipeline my-pipe    # batch (pipeline.py)
uvx pixeltable-new --template data-lab my-dataset         # batch (export.py)
Template Pattern What you get
multimodal-rag serving + backend Unified search across docs, images, video, audio. schema.py + app.py + web UI
video-intel serving Declarative video pipeline: frames, transcription, detection, search. Pure schema.py
agent serving + backend Persistent agent with durable memory, tools, MCP. schema.py + app.py + web UI
audio-intel serving + backend Transcription, diarization, summarization, semantic search. schema.py + app.py + web UI
content-pipeline batch Ingest from S3, process all modalities, export to your DB. schema.py + pipeline.py
data-lab batch Auto-annotate, curate, version, export to PyTorch. schema.py + export.py

Structural Patterns

API/pipeline scaffolds for when you want to wire Pixeltable into your own architecture:

uvx pixeltable-new myapp --serving    # Declarative API from TOML config (default)
uvx pixeltable-new myapp --backend    # FastAPI API scaffold (headless)
uvx pixeltable-new myapp --batch      # Batch processing script
Pattern What you get Run with
--serving (default) schema.py + pyproject.toml routes pxt serve <service-name>
--backend FastAPI API scaffold + Pixeltable schema + routers uvicorn main:app --reload
--batch Ingest script + export_sql python pipeline.py

Discovery

uvx pixeltable-new --list    # show all patterns + templates

All content is fetched from the Pixeltable Starter Kit. For the full reference with Docker, Helm, Terraform, and cloud deploy configs, clone the starter kit directly.

Existing directory

If you want to create a new Pixeltable project in an existing directory, run the command without a project name:

uvx pixeltable-new

Learn more

Releasing

Releases are published to PyPI automatically when a version tag is pushed.

One-time setup (trusted publishing)

  1. Go to pypi.org/manage/project/pixeltable-new/settings/publishing/
  2. Add a new trusted publisher:
    • Owner: pixeltable
    • Repository: pixeltable-new
    • Workflow: publish.yml
    • Environment: pypi
  3. Create a GitHub environment called pypi at github.com/pixeltable/pixeltable-new/settings/environments

Publishing a release

# 1. Bump version in src/pixeltable_new/__init__.py
# 2. Update release-notes.md
# 3. Commit, tag, push
git add -A && git commit -m "v0.3.0: description of changes"
git tag v0.3.0
git push && git push --tags

The CI workflow runs the full test matrix, then publishes to PyPI via OIDC (no API token needed).

Manual publish (fallback)

If trusted publishing isn't configured yet, publish manually with a PyPI API token scoped to the pixeltable-new project:

uv build
uv publish --token pypi-YOUR_TOKEN_HERE

License

This project is licensed under the terms of the Apache 2.0 license.

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

pixeltable_new-0.3.1.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

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

pixeltable_new-0.3.1-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file pixeltable_new-0.3.1.tar.gz.

File metadata

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

File hashes

Hashes for pixeltable_new-0.3.1.tar.gz
Algorithm Hash digest
SHA256 386f5353adedfd4df2f3b4eea4cf6ba42f05efa74fd4d27b73695088155e03a7
MD5 eaebcd81565ff81fbd09c362511d5ba1
BLAKE2b-256 deb0f9cb26e11730cf2d9b656e95ca788dd1a301e7e2c1d43bde29c73ddd35cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pixeltable_new-0.3.1.tar.gz:

Publisher: publish.yml on pixeltable/pixeltable-new

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

File details

Details for the file pixeltable_new-0.3.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for pixeltable_new-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b7a2334624fd6c560533e409fd017b4d25be80fc28abc99cc35739755df5f9a4
MD5 207c37ae5862e11b1017dfb740cc83a2
BLAKE2b-256 de18d9c3bf11f28cf0b208a8c57535763a066c36c52c1a6b0c709f1c6d6936ba

See more details on using hashes here.

Provenance

The following attestation bundles were made for pixeltable_new-0.3.1-py3-none-any.whl:

Publisher: publish.yml on pixeltable/pixeltable-new

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