Installation
The labstep package can be easily installed using pip
.
Open the Terminal
, and do:
pip install labstep
Authentication
Every session starts with importing the labstep module and accessing
your Labstep account using the
authenticate()
method and an API key.
For guidance on generating an API key to connect to your Labstep account see this article.
- labstep.authenticate(username=OPTIONAL, apikey=OPTIONAL)
Returns an authenticated Labstep User object to allow you to interact with the Labstep API.
- Parameters:
username (str) – Your Labstep username.
apikey (str) – An apikey for the user.
- Returns:
An object representing a user on Labstep.
- Return type:
Example
import labstep user = labstep.authenticate('myaccount@labstep.com', 'MY_API_KEY')