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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a134b9066d04c5a1f01f7bf235a34b522984fffed1a8154f9f03bdb2ac7e08d8 |
|
MD5 | 410fe330e30c84db2ab0f69c3fdc3626 |
|
BLAKE2b-256 | a771f462a7a254eabe2af102b3f17423247678afa77c9f5ae889aba53dd97c5d |
Hashes for mstr_rest_requests-0.11.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e2d3b0845e591bcfab5d2c6b696515d1fc44c4bdee403c2385f02b8e66bea25 |
|
MD5 | 8a175df6009fed03f5c7bf4e25e6ab03 |
|
BLAKE2b-256 | 951a934ff23a99d356f4c314eab002dd27c3a56d5e89773a0f80cb15f1898507 |