Metadata-Version: 2.1
Name: speckle
Version: 2.0.2
Summary: A Python client for Speckle servers.
Home-page: https://github.com/specklworks/pyspeckle
Author: Speckle Works
Author-email: devops@speckle.works
License: UNKNOWN
Description: # PySpeckle
        A Python Speckle Client
        
        [![Build Status](https://travis-ci.com/speckleworks/PySpeckle.svg?branch=master)](https://travis-ci.com/speckleworks/PySpeckle)
        
        [Speckle.Works](https://www.speckle.works)
        
        > 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](https://github.com/speckleworks/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:
        ```python
        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](https://pyspeckle.readthedocs.io/en/latest/).
        
        
        
        ## Maintainers
        SpeckleBlender is written and maintained by [Tom Svilans](http://tomsvilans.com) ([Github](https://github.com/tsvilans)), [Izzy Lyseggen](https://github.com/izzylys) and [Antoine Dao](https://github.com/antoinedao).
        
        ## Notes
        Commit formatting can be found [here](https://gist.github.com/brianclements/841ea7bffdb01346392c#type).
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
