Installation

Install the Pictograph Python SDK with pip. Supports Python 3.8-3.12 for accessing computer vision annotation data.

Requirements

  • Python 3.8+ (3.9, 3.10, 3.11, 3.12 supported)
  • pip or another Python package manager

Install with pip

Bash
pip install pictograph

This installs the SDK with its dependencies:

  • requests - HTTP client
  • Pillow - Image processing
  • tqdm - Progress bars

Install with Poetry

Bash
poetry add pictograph

Install from Source

For development or to get the latest changes:

Bash
git clone https://github.com/pictograph-io/pictograph-sdk.git
cd pictograph-sdk
pip install -e .

Verify Installation

Python
import pictograph
print(pictograph.__version__)  # 0.1.10

Get Your API Key

Before using the SDK, you'll need an API key:

  1. Log in to app.pictograph.io
  2. Go to SettingsAPI Keys
  3. Click Generate New Key
  4. Copy the key (it's only shown once)

Recommended Setup

Store your API key as an environment variable:

Bash
# Add to your .bashrc, .zshrc, or .env file
export PICTOGRAPH_API_KEY="pk_live_your_key_here"

Then load it in your code:

Python
import os
from pictograph import Client

client = Client(api_key=os.environ["PICTOGRAPH_API_KEY"])

Next Steps

Copied to clipboard