Skip to main content

Embed images into portable text files and extract them back

Project description

PixelFuse Backend

FastAPI service that embeds images into portable text files and extracts them back.

Docs

# File Description
001 Overview What PixelFuse does and the text file format
002 API Reference Endpoint contracts, fields, and error codes
003 Configuration Env vars and CLI flags
004 Development Local setup, tests, lint, Docker
005 Deployment Render, CI, self-hosted Docker

Endpoints

Method Path Description
POST /convert-embed/ Upload images → download base64 text file
POST /extract-images/ Upload text file → download ZIP of images

Supports JPEG, PNG, and HEIC formats. Max 10 files per request (configurable).

No distortion. Embed → extract is lossless. Raw image bytes are base64-encoded and decoded back exactly — no re-encoding at any stage.

Quickstart

pip install -e ".[dev]"
pixelfuse serve --reload

Configuration

All settings are overridable via environment variables prefixed PIXELFUSE_:

Variable Default Description
PIXELFUSE_HOST 0.0.0.0 Bind host
PIXELFUSE_PORT 8000 Bind port
PIXELFUSE_LOG_LEVEL info Uvicorn log level
PIXELFUSE_MAX_UPLOAD_FILES 10 Max files per request
PIXELFUSE_RATE_LIMIT_PER_MINUTE 60 Max requests per minute per IP (0 = disabled)
PIXELFUSE_ALLOWED_ORIGINS (required) CORS origins (JSON array)

Copy .env.example to .env for local overrides.

Development

# Lint
flake8 src tests

# Type check
mypy src

# All environments
tox

Deployment

Deployed on Render via render.yaml. CI runs on every push via GitHub Actions.

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

bh_pixelfuse-0.0.5.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

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

bh_pixelfuse-0.0.5-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file bh_pixelfuse-0.0.5.tar.gz.

File metadata

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

File hashes

Hashes for bh_pixelfuse-0.0.5.tar.gz
Algorithm Hash digest
SHA256 46c3d9692f06a734d80546ea8d8b662f0f21b9206138520f22374d4e179350fa
MD5 1ddf4c8275fe72b4414c100848f110e2
BLAKE2b-256 9c6e617144280d2dde879a0ecf17dc39a88382d1e82f7dca5cf26ef2c11f5119

See more details on using hashes here.

Provenance

The following attestation bundles were made for bh_pixelfuse-0.0.5.tar.gz:

Publisher: release.yml on abin-m/pixelfuse-backend

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

File details

Details for the file bh_pixelfuse-0.0.5-py3-none-any.whl.

File metadata

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

File hashes

Hashes for bh_pixelfuse-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 012e26b3378027a44fb56ba7e914e239e6c729c25ebc82423d6b14c005868f29
MD5 65c16c2179e818b579e18fc2c0a82ae4
BLAKE2b-256 6402d151bcb961b1b4a269461f111991773292ef7f22ed32c60fc42b86d70df3

See more details on using hashes here.

Provenance

The following attestation bundles were made for bh_pixelfuse-0.0.5-py3-none-any.whl:

Publisher: release.yml on abin-m/pixelfuse-backend

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