PyPI 官网下载 | mstrio-py-11.2.2.1.1734.tar.gz

![MicroStrategy Logo][logo] [](https://pypi.org/project/mstrio-py) [](https://pypi.org/project/mstrio-py) [](https://pypi.org/project/mstrio-py) # mstrio: Simple and Secure Access to MicroStrategy Data <!-- omit in toc --> **mstrio** provides a high-level interface for [Python][py_github] and [R][r_github] and is designed to give data scientists and developers simple and secure access to MicroStrategy data. It wraps [MicroStrategy REST APIs][mstr_rest_docs] into simple workflows, allowing users to connect to their MicroStrategy environment, fetch data from cubes and reports, create new datasets, and add new data to existing datasets. And, because it enforces MicroStrategy's user and object security model, you don't need to worry about setting up separate security rules. With **mstrio**, it's easy to integrate cross-departmental, trustworthy business data in machine learning workflows and enable decision-makers to take action on predictive insights in MicroStrategy reports, Dossiers, HyperIntelligence Cards, and customized, embedded analytical applications. **MicroStrategy for Jupyter** is an extension for Jupyter Notebook which provides a graphical user interface for **mstrio-py** methods with the help of which user can perform all of the import and export actions without writing a single line of code manually. MicroStrategy for Jupyter is contained within **mstrio-py** package and is available after installation and enabling as Jupyter extension. # Table of Contents <!-- omit in toc --> <!--ts--> - [Installation](#installation) - [Prerequisites](#prerequisites) - [mstrio-py](#mstrio-py) - [MicroStrategy for Jupyter](#microstrategy-for-jupyter) - [Install the `mstrio-py` Package](#install-the-mstrio-py-package) - [Enable the Jupyter Notebook extension](#enable-the-jupyter-notebook-extension) - [Versioning & Main Features](#versioning--main-features) - [Versioning](#versioning) - [Main Features](#main-features) - [Usage](#usage) - [Connect to MicroStrategy](#connect-to-microstrategy) - [Authentication Methods](#authentication-methods) - [SSL Self-signed Certificate](#ssl-self-signed-certificate) - [Import Data from Cubes and Reports](#import-data-from-cubes-and-reports) - [Export Data into MicroStrategy with Datasets](#export-data-into-microstrategy-with-datasets) - [Create a New Dataset](#create-a-new-dataset) - [Update a Dataset](#update-a-dataset) - [Certify a dataset](#certify-a-dataset) - [Limitations](#limitations) - [More Resources](#more-resources) - [Other](#other) <!--te--> # Installation ## Prerequisites ### mstrio-py * Python 3.6+ * MicroStrategy 2019 Update 4 (11.1.4)+ ### MicroStrategy for Jupyter * mstrio-py 11.1.4+ * Jupyter Notebook 6.0.2+ * ipywidgets 7.5.1+ * [CORS enabled on MicroStrategy Library server][cors_manual] * [Cookies sent by MicroStrategy Library server have `SameSite` parameter set to `None`][same_site_manual] ## Install the `mstrio-py` Package **Note**: it is not recommended to install mstrio-py in an Anaconda environment. For a seamless experience, install and run it in Python's [virtual environment][python_venv] instead. Installation is easy when using [pip](https://pypi.org/project/mstrio-py). Read more about installation on MicroStrategy's [product documentation][mstr_help_docs]. ``` pip3 install mstrio-py ``` ## Enable the Jupyter Notebook extension Once mstrio-py is installed you can install and enable the Jupyter Notebook extension by using the commands below: ``` jupyter nbextension install connector-jupyter --py --sys-prefix jupyter nbextension enable connector-jupyter --py --sys-prefix ``` # Versioning & Main Features ## Versioning Current version: **11.2.2.1** (4 August 2020). Check out [Release Notes][release_notes] to see what's new. Functionalities may be added to mstrio either in combination with annual MicroStrategy platform releases or through updates to platform releases. To ensure compatibility with APIs supported by your MicroStrategy environment, it is recommended to install a version of mstrio that corresponds to the version number of your MicroStrategy environment. The current version of mstrio-py is 11.2.2.1 and is supported on MicroStrategy 2019 Update 4 (11.1.4) and later. To leverage MicroStrategy for Jupyter, mstrio-py (11.1.4), Jupyter Notebook (6.0.2), ipywidgets (7.5.1) and MicroStrategy 2019 Update 4 (11.1.4) or higher are required. If you intend to use mstrio with MicroStrategy version older than 11.1.4, refer to the Pypi package archive to download mstrio 10.11.1, which is supported on: * MicroStrategy 2019 (11.1) * MicroStrategy 2019 Update 1 (11.1.1) * MicroStrategy 2019 Update 2 (11.1.2) * MicroStrategy 2019 Update 3 (11.1.3) Refer to the [PyPi package archive][pypi_archive] for a list of available versions. To install a specific, archived version of mstrio, choose the desired version available on [PyPi's package archive][pypi_archive] and install with `pip`, as follows: ```python pip install mstrio-py==10.11.1 ``` ## Main Features Read the following tutorials to become more familiar with **mstrio-py** - Connect to your MicroStrategy environment - Import data from a Report into a Pandas DataFrame - Import data from a Cube into a Pandas DataFrame - Filter Cubes and Reports by selecting Attributes and Metrics or specifying a view filter - Export data into MicroStrategy by creating Datasets - Update, replace, or append new data to an existing Dataset # Usage ## Connect to MicroStrategy The `Connection` object manages your connection to MicroStrategy. Connect to your MicroStrategy environment by providing the URL to the MicroStrategy REST API server, your username, password and the ID of the Project to connect to. When a `Connection` object is created the user will be automatically logged-in. ```python from mstrio.connection import Connection import getpass base_url = "https://your-microstrategy-server.com/MicroStrategyLibrary/api" mstr_username = "Username" mstr_password = getpass.getpass("Password: ") project_id = "PROJECT_ID" conn = Connection(base_url, mstr_username, mstr_password, project_id=project_id) ``` The URL for the REST API server typically follows this format: _https://your-microstrategy-server.com/MicroStrategyLibrary/api_ Validate that the REST API server is running by accessing _https://your-microstrategy-server.com/MicroStrategyLibrary/api-docs_ in your web browser. To manage the connection the following methods are made available: ```python conn.connect() conn.renew() conn.close() conn.status() ``` ### Authentication Methods Currently, supported authentication modes are **Standard** (the default) and **LDAP**. To use LDAP, add `login_mode=16` when creating your `Connection` object: ```python conn = Connection(base_url, mstr_username, mstr_password, project_id=project_id, login_mode=16) ``` Optionally, the `Connection` object can be created by passing the `identity_token` parameter, which will create a delegated session. The identity token can be obtained by sending a request to MicroStrategy REST API `/auth/identityToken` endpoint. ```python conn = Connection(base_url, identity_token=identity_token, project_id=project_id) ``` ### SSL Self-signed Certificate By default, SSL certificates are validated with each API request. To turn this off, use `ssl_verify` flag: ```python conn = Connection(base_url, mstr_username, mstr_password, project_id=project_id, ssl_verify=False) ``` If you are using a SSL with a self-signed certificate you will need to perform an additional step to configure your connection. There are 2 ways to set it up: 1. The easiest way to configure the SSL is to move your certificate file to your working directory. Just make sure the `ssl_verify` parameter is set to `True` when creating the `Connection` object in