Skip to main content

Installation

Requirements​

  • Python 3.8 or higher
  • pip package manager

Install from PyPI​

pip install structurify

Install with Async Support​

For async/await support with aiohttp:

pip install structurify[async]

Verify Installation​

import structurify
print(structurify.__version__)

Environment Setup​

We recommend using environment variables for your API key:

# Add to your shell profile (~/.bashrc, ~/.zshrc, etc.)
export STRUCTURIFY_API_KEY=sk_live_your_api_key

Then in your code:

import os
from structurify import Structurify

client = Structurify(api_key=os.environ['STRUCTURIFY_API_KEY'])

Create an isolated environment for your project:

# Create virtual environment
python -m venv venv

# Activate (Linux/macOS)
source venv/bin/activate

# Activate (Windows)
venv\Scripts\activate

# Install structurify
pip install structurify

Upgrade​

pip install --upgrade structurify

Development Installation​

For contributing to the SDK:

git clone https://github.com/DscvryAI/structurify-sdk.git
cd structurify-sdk/python
pip install -e ".[dev]"