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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c91378657daf1f2412f05388cd052095d11f2bd83b29c5d3b27a436be73dc7e1 |
|
MD5 | 4482cfd2783488fa8d76f8ac0f6c1ed9 |
|
BLAKE2b-256 | 613b6c8104ab1e0e5b7ae0cdf9905d9408fda97661e1915fcfa1c8764efa8f0f |
Hashes for mstr_rest_requests-0.11.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b825eec2771df598074d6c92c26dcb139ca2955f10d300aa7bf95d1791dd94c |
|
MD5 | e1d6e9d4e1cfb8d51a275ef7f20a632c |
|
BLAKE2b-256 | 9863c7328d97bf99e7528c091b9dfd8d40db0e9fa3a4bdec9646e44af9425db6 |