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.14.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9355164b492948ffad14bb1d5f674f32838aab52d5c4cf08125a596a62ce2171 |
|
MD5 | c2bee84f62ad3b8c2a6d803e8048a2ce |
|
BLAKE2b-256 | 90aafd31ea26930544c2489839f1cb783946fa0a96485fdf39019330558f703c |
Hashes for mstr_rest_requests-0.14.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2ab25ad64d15434a715eb274730655802787df03a90c8ddaad20bff1a3c31ec |
|
MD5 | 8cf28802db985fdf48e7327cfde9a970 |
|
BLAKE2b-256 | 23cf44834ca2d6da308778bc106475833c722104b3aa8aed06d647e0996a7816 |