Easily make requests of the MicroStrategy REST API
Project description
mstr-rest-requests
A extension to the excellent requests
Session
object, to enable more straightforward interaction with MicroStrategy's REST API.
Usage
Installation
Simply install the package however you normally install them, for example:
pip install mstr-rest-requests
Examples
Authentication
Here's how to get an authenticated session (currently only standard and anonymous authentication are supported):
from mstr.requests import MSTRRESTSession
session = MSTRRESTSession(base_url='https://demo.microstrategy.com/MicroStrategyLibrary/api/')
session.login(username='dave', password='hellodave')
session.has_session()
# returns True
Session handling
Several convenience methods are implemented to make dealing with Session objects easier.
def has_session(self)
Will return a boolean as to whether the session contains an authentication tokem.
def destroy_auth_token(self)
Removes the auth token from the session
def json(self)
Returns a JSON representation of the session that can be reconstituted with:
update_from_json(self, data)
where data
is either a dict or a string containing JSON data.
HTTP requests
The MSTRRESTSession adds two parameters to all request methods:
include_auth=True, project_id=None
so you can specify a project_id
on any request by adding the parameter.
Convenience methods for API calls
TODO
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mstr-rest-requests-0.12.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a971a48d2a4db25e0ac4c9f666ca54e9f5573ba4e8909e15b15150ad0b1bc69f |
|
MD5 | 464ac19a41c250ae815e847e278788ee |
|
BLAKE2b-256 | 796ad66588ea1612cb388f89fa03591f1c81992e31e3547ea7839ff9379c7815 |
Hashes for mstr_rest_requests-0.12.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29b0748750d2c8817b5106e6b06efa9fa554bf558a3885c0b1c5be7780cc1453 |
|
MD5 | 1ec6c72d7e8fadd204832f631a121cc3 |
|
BLAKE2b-256 | 5c2b11d34f4ad1e638e6b65117581d776f3936cdf24ce80350099a4b80af4fc2 |