Skip to main content

A lightweight developer kit for packaging AI agents into portable APKG files

Project description

Pixell Kit

A lightweight developer kit for packaging AI agents into portable, standardized APKG files.

Installation

Using pipx (Recommended)

pipx install pixell-kit

Using Homebrew

brew install pixell-kit

Using pip

pip install pixell-kit

Quick Start

# Create a new agent project
pixell init my_agent

# Run locally for development
cd my_agent
pixell run-dev

# Build into APKG package
pixell build

# Inspect the package
pixell inspect my_agent-0.1.0.apkg

Configuration

Pixell Kit supports flexible configuration management to avoid entering credentials repeatedly. You can configure API keys and app IDs at multiple levels with the following precedence order:

1. Environment Variables (Highest Priority)

export PIXELL_API_KEY=your-api-key
export PIXELL_APP_ID=your-app-id
export PIXELL_ENVIRONMENT=prod

2. Project-Level Configuration

Create .pixell/config.json in your project directory:

{
  "api_key": "your-api-key",
  "app_id": "your-default-app-id",
  "default_environment": "prod",
  "environments": {
    "prod": {"app_id": "your-production-app-id"},
    "staging": {"app_id": "your-staging-app-id"},
    "local": {"app_id": "your-local-app-id"}
  }
}

3. Global Configuration

Create ~/.pixell/config.json for user-wide settings:

{
  "api_key": "your-api-key",
  "app_id": "your-default-app-id"
}

Configuration Commands

# Interactive setup (recommended for first-time users)
pixell config init

# Set individual values
pixell config set --api-key your-api-key
pixell config set --app-id your-app-id
pixell config set --env-app-id prod:your-prod-app-id
pixell config set --env-app-id staging:your-staging-app-id

# Set global configuration (affects all projects)
pixell config set --global --api-key your-api-key

# View current configuration
pixell config show
pixell config show --global

Simplified Deployment

Once configured, you can deploy without specifying credentials every time:

# Deploy to production (uses stored credentials)
pixell deploy --apkg-file my_agent-0.1.0.apkg

# Deploy to staging (uses environment-specific app ID)
pixell deploy --apkg-file my_agent-0.1.0.apkg --env staging

# Deploy to local development
pixell deploy --apkg-file my_agent-0.1.0.apkg --env local

Features

  • 📦 Package any AI agent into portable APKG files
  • 🚀 Local development server with hot-reload
  • ✅ Manifest validation and package integrity
  • 🔐 Optional package signing with GPG
  • 🐍 Python 3.11+ support (TypeScript coming soon)

Documentation

See the full documentation for detailed usage.

License

This project is licensed under the GNU Affero General Public License v3.0.

For organizations that do not wish to comply with AGPL-3.0 requirements, commercial licensing options are available. Contact us at engineering@pixell.global .

Trigger publish workflow

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

pixell_kit-0.4.3.tar.gz (46.0 kB view details)

Uploaded Source

Built Distribution

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

pixell_kit-0.4.3-py3-none-any.whl (52.4 kB view details)

Uploaded Python 3

File details

Details for the file pixell_kit-0.4.3.tar.gz.

File metadata

  • Download URL: pixell_kit-0.4.3.tar.gz
  • Upload date:
  • Size: 46.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pixell_kit-0.4.3.tar.gz
Algorithm Hash digest
SHA256 f9812e4b6831c53d033abdcdef95cc9134d5224a8756024b2ebb7cbaf84e89f9
MD5 898c5e06447b13f2245032b8ae87218c
BLAKE2b-256 a6776aafe6b372116798f0707047efb5ccdbe197157aa54b534ba62f344a5a97

See more details on using hashes here.

Provenance

The following attestation bundles were made for pixell_kit-0.4.3.tar.gz:

Publisher: publish-main.yml on pixell-global/pixell-kit

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

File details

Details for the file pixell_kit-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: pixell_kit-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 52.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pixell_kit-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cf9a4462101b69d2c854ad984e3d711919415a3ee9582cbafc88b04b8ace7f93
MD5 d94579e340b71070555a87359042c8e5
BLAKE2b-256 c3e21e44fad99f7aa2451e1037ab9d443202c51ae2d38568ab2d84740b3bf047

See more details on using hashes here.

Provenance

The following attestation bundles were made for pixell_kit-0.4.3-py3-none-any.whl:

Publisher: publish-main.yml on pixell-global/pixell-kit

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