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_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-1.0.0.tar.gz (5.7 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-1.0.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for bh_pixelfuse-1.0.0.tar.gz
Algorithm Hash digest
SHA256 516fff145bed732f20991fc4f554039ea0bfd30df2c128efdedee6a87c01d3c4
MD5 68b9d5ab8b5d558d28f019371897f597
BLAKE2b-256 c7e92970e4d12ebb960f8d193184fcf89c2e1e80b42537eae2cd3b2f2473e611

See more details on using hashes here.

Provenance

The following attestation bundles were made for bh_pixelfuse-1.0.0.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-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: bh_pixelfuse-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 6.6 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-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c25cd56aa5bad263618d0e779d083d7cb70cb09db3c34c4a636ccdcd6431b7a9
MD5 6b8bdbd43abecd906d215d2d558558cd
BLAKE2b-256 599264444e5d14923361002dbbcdf518b0128cd4cd0ef37c9e2c0d618edc399f

See more details on using hashes here.

Provenance

The following attestation bundles were made for bh_pixelfuse-1.0.0-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