Skip to main content

Official Python SDK for Visual Factory image automation API

Project description

visualfactory-python

Official Python SDK for Visual Factory.

Install

pip install visualfactory-python
# or from monorepo:
pip install ./packages/python-sdk

Quick start

from visualfactory import VisualFactory

vf = VisualFactory("vf_live_your_api_key", base_url="https://factory.example.com")

# One-liner — enqueue + poll
result = vf.images.remove_background("./shoe.jpg")
print(result["status"], result.get("result", {}).get("imageSrc", "")[:80])

# Webhook registration
vf.create_webhook("https://firma.com/api/vf-callback", events=["job.completed", "job.failed"])

Parity with Node SDK

Node (@visualfactory/node) Python
new VisualFactory(apiKey) VisualFactory(api_key)
vf.images.removeBackground(file) vf.images.remove_background(path)
vf.createWebhookSubscription(...) vf.create_webhook(...)
vf.pollJob(id) vf.poll_job(id)

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

visualfactory-1.0.0.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

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

visualfactory-1.0.0-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: visualfactory-1.0.0.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for visualfactory-1.0.0.tar.gz
Algorithm Hash digest
SHA256 fe5da2b2911e1c6ef1b08d9a49b16fc238bc39fe3533b38c3aa474209467bc1a
MD5 29f36fbef86112a6885a64f97f21a4c2
BLAKE2b-256 52e8c121918886419abe4e17fe8627b71beeff7be7d620d9bc7e3160502df770

See more details on using hashes here.

File details

Details for the file visualfactory-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: visualfactory-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for visualfactory-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bcde6c378163bce2764815c72e8a211e02818e0020e242301aaa06df6d410e7a
MD5 4850b7c17939969840e0dbb970af7284
BLAKE2b-256 3fa3f4c00e59120700c461177eff80d751e7fba23e7f988a1a887084da3bd40e

See more details on using hashes here.

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