Skip to main content

​
Requirements

specklepy requires:
  • Python 3.10 or higher (Python 3.10, 3.11, 3.12, 3.13 supported)
specklepy works on Windows, macOS, and Linux.

​
Install with pip

You can install specklepy using pip in the current environment: 
pip install specklepy

​
Install a Specific Version

To install a specific version: 
pip install specklepy==3.0.10

​
Upgrade to Latest Version

To upgrade an existing installation: 
pip install --upgrade specklepy
It’s best practice to use a virtual environment to avoid dependency conflicts.

​
Verify Installation

Confirm specklepy is installed correctly: 
import specklepy
print(f"specklepy version: {specklepy.__version__}")
You can also check available modules: 
from specklepy.api.client import SpeckleClient
from specklepy.objects.geometry import Point
from specklepy.api import operations

print("✓ specklepy installed successfully!")

​
Dependencies

specklepy automatically installs these dependencies:
PackagePurpose
gql[requests,websockets]GraphQL client for Speckle Server API
pydanticData validation and serialization
appdirsCross-platform directory paths
stringcaseString case conversion
ujsonFast JSON parsing
deprecatedDeprecation warnings
You don’t need to install these manually - pip handles them automatically.

​
Development Installation

If you want to contribute to specklepy or modify the source code refer to the contributing guide.

​
Next Steps

Now that you have specklepy installed, learn how to authenticate:

Authentication

Set up authentication with Speckle Server