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.13.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e9008e73f1a9503e2b595509600740e2f54bd4ef99f65146adab2349e112581 |
|
MD5 | 9374d327b5b5a060c3891475c0015cd2 |
|
BLAKE2b-256 | a884088bb394b281eb55518332968f5361b5486bf663d34346a3351fe6a953d1 |
Hashes for mstr_rest_requests-0.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aeda46f90870e181521e2487628129b9afea1d57f097542407b34266b023f095 |
|
MD5 | 15c5b1e30887f88e6199ae357ad0025e |
|
BLAKE2b-256 | 216e594d46aae9ce119e579dd5e68094bc5c228e61bf2a33ec06e6586a265d22 |