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.10.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed0937ba51f726c9d67fc1962bb03dad49ac394e8855bb31d9749b3a6b77819f |
|
MD5 | 2980ec00e8a47683e9a7a21a2accfa36 |
|
BLAKE2b-256 | 15a403ea7ed5ab08ba883928563193c19ce1e4d7564d6243b889f2ace75e0573 |
Hashes for mstr_rest_requests-0.10.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ae358295fc9b1bf8091c6adf84e5ea8123b3d1ea695cb2ac2e3e64690eaaf81 |
|
MD5 | 61749180903285b4cbe7d7797dbaa3e2 |
|
BLAKE2b-256 | 76541fd34fbd50d222b44c3792a3f0e9407da3b856893287052de38eb178724d |