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.11.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d00065bc6697f73111ba19484d85f743f99342ac768ecf63a113c1b2fbd5bf19 |
|
MD5 | 86180b76a06e64aedf45c956f2641fed |
|
BLAKE2b-256 | c44bfcb7aa35d483791cf0e08650da49ba3101ea4155eda7e3d86be92cff45c2 |
Hashes for mstr_rest_requests-0.11.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1376957915ef86580bc647b553e57a35d7c02e2976deb9e9af9baf0a79acd0a7 |
|
MD5 | eb4332f996e67e2321fee790f2ce9e45 |
|
BLAKE2b-256 | fac03cd4886963b1487bdee6cb048d1aed716cf973106ee97405f8f89e6e96df |