Welcome to PySpeckle’s documentation!¶
PySpeckle¶
A Python Speckle Client
Speckle: open digital infrastructure for designing, making and operating the built environment. We reimagine the design process from the Internet up: Speckle is an open source (MIT) initiative for developing an extensible Design & AEC data communication and collaboration platform.
Installation¶
PySpeckle can be installed through pip
:
pip install speckle
Disclaimer¶
This code is WIP and as such should be used with caution, on non-sensitive projects.
Description¶
PySpeckle is a light Python wrapper / interface for the Speckle framework. It can be used independently through Python scripts, or as a base for building various plug-ins, such as SpeckleBlender.
At the moment, it copies the same method names from the .NET SpeckleApiClient
, for consistency’s sake. Although the functions are mostly labelled ‘Async’, they are not yet. This could eventually be implemented with requests_futures
or grequests
or similar.
Quick Start¶
Here is how you initialise a client, authenticate and start speckling:
from speckle import SpeckleApiClient
client = SpeckleApiClient('hestia.speckle.works')
client.login(
email='test@test.com',
password='Speckle<3Python'
)
stream_id = 'HjenwS2s'
objects = client.streams.list_objects(stream_id)
for object in objects:
print(object.dict())
Usage documentation can be found here.
Maintainers¶
SpeckleBlender is written and maintained by Tom Svilans (Github), Izzy Lyseggen and Antoine Dao.