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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00cfdd938895e3735a5a255508f3cdf06d9bf8ae50b50a3b49a9a31f97f77d21 |
|
MD5 | 09905e84a17db8bedaa4c9cd9e99f3e9 |
|
BLAKE2b-256 | 3ee014754850a16d07f80458623b89c4403edb4ad10823d937905b7fe4f692c7 |
Hashes for mstr_rest_requests-0.12.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c5ab5c9426f1de0cb2fb5bb7da0b0d7b9f0fe408c54739a0f98fb70bb6018b5 |
|
MD5 | 5776cf2d30c7a119b1fad847646ad79b |
|
BLAKE2b-256 | 0cf049aabc883299098488929a2e6963395daffc1702569beba3d787be7373ac |