Metadata-Version: 2.1
Name: mstrio-py
Version: 11.3.0.2
Summary: Python interface for the MicroStrategy REST API
Home-page: https://github.com/MicroStrategy/mstrio-py
Author: Scott Rigney, Peter Ott, Sergio Sainz Palacios, Michal Ciesielski, Zofia Rogala, Ignacy Hologa, Piotr Czyz, Oskar Duda, Wojciech Antonczyk, Michal Drzazga, Adam Piotrowski
Author-email: srigney@microstrategy.com, ssainz@microstrategy.com, mciesielski@microstrategy.com,zrogala@microstrategy.com, ihologa@microstrategy.com, pczyz@microstrategy.com, oduda@microstrategy.com, wantonczyk@microstrategy.com, mdrzazga@microstrategy.com, apiotrowski@microstrategy.com
License: Apache License 2.0
Project-URL: Bug Tracker, https://github.com/MicroStrategy/mstrio-py/issues
Project-URL: Documentation, http://www2.microstrategy.com/producthelp/Current/mstrio-py/
Project-URL: Source Code, https://github.com/MicroStrategy/mstrio-py
Project-URL: Quick Manual, https://www2.microstrategy.com/producthelp/current/MSTR-for-Jupyter/Content/mstr_for_jupyter.htm
Description: ![MicroStrategy Logo][logo]
        
        [![image](https://img.shields.io/pypi/v/mstrio-py.svg)](https://pypi.org/project/mstrio-py)
        [![image](https://img.shields.io/pypi/l/mstrio-py.svg)](https://pypi.org/project/mstrio-py)
        [![image](https://img.shields.io/pypi/dm/mstrio-py.svg)](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-->
        - [Main Features](#main-features)
        - [Documentation](#documentation)
        - [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 & Changelog](#versioning--changelog)
        - [More Resources](#more-resources)
        - [Other](#other)
        <!--te-->
        
        # Main Features
        
        Main features of **mstrio-py** allows to access MicroStrategy data:
        
        - Connect to your MicroStrategy environment using **Connection** class (see [examples][example_conn])
        - Import and filter data from a **Cube** or **Report** into a Pandas DataFrame (see [examples][example_import])
        - Export data into MicroStrategy by creating or updating **Dataset** (see [examples][example_export])
        
        Since version **11.3.0.1**, **mstrio-py** includes also administration modules:
        
        - **Application** management module (see [examples][example_app])
        - **Server** management module (see [examples][example_server])
        - **User** and **Usergroup** management modules (see [examples][example_user])
        - **Subscription** and **Schedules** management modules (see [examples][example_subs])
        - **Document** and **Dossiers** in **User Library** modules (see [examples][example_library])
        - **User Connections** management module
        - **Privilege** and **Security Role** management modules
        
        # Documentation
        
        Detailed information about **mstrio-py** package can be found in [official documentation][mstrio_py_doc].
        
        # Installation
        
        ## Prerequisites
        
        ### mstrio-py
        
        - Python 3.6+
        - MicroStrategy 2019 Update 4 (11.1.4)+
        
        ### MicroStrategy for Jupyter
        
        - [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].
        
        ```bash
        pip 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 & Changelog
        
        Current version: **11.3.0.2** (11 January 2021). Check out [Changelog][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.
        
        **mstrio-py** is divided into two separate modules, first of which is meant for data-science related activities, while the second one is for administrative tasks. Former requires at least MicroStrategy 2019 Update 4 (11.1.4), latter works with 11.2.1 and higher but all features are available with MicroStrategy 11.3.0.
        
        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 package archive][pypi_archive] and install with `pip`, as follows:
        
        ```python
        pip install mstrio-py==10.11.1
        ```
        
        # More Resources
        
        - [Tutorials for mstrio][mstr_datasci_comm]
        - [Check out mstrio for R][r_github]
        - [Learn more about the MicroStrategy REST API][mstr_rest_docs]
        - [MicroStrategy REST API demo documentation][mstr_rest_demo]
        
        # Other
        
        "Jupyter" and the Jupyter logos are trademarks or registered trademarks of NumFOCUS.
        
        [pypi_archive]: <https://pypi.org/project/mstrio-py/#history>
        [py_github]: <https://github.com/MicroStrategy/mstrio-py>
        [r_github]: <https://github.com/MicroStrategy/mstrio>
        [mstr_datasci_comm]: <https://community.microstrategy.com/s/topic/0TO44000000AJ2dGAG/python-r-u108>
        [mstrio_py_doc]: <http://www2.microstrategy.com/producthelp/Current/mstrio-py/>
        [mstr_rest_demo]: <https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html>
        [mstr_rest_docs]: <https://lw.microstrategy.com/msdz/MSDL/GARelease_Current/docs/projects/RESTSDK/Content/topics/REST_API/REST_API.htm>
        [mstr_help_docs]: <https://www2.microstrategy.com/producthelp/current/MSTR-for-Jupyter/Content/mstr_for_jupyter.htm>
        [cors_manual]: <https://lw.microstrategy.com/msdz/MSDL/GARelease_Current/docs/projects/EmbeddingSDK/Content/topics/EnableCORS.htm>
        [same_site_manual]: <https://community.microstrategy.com/s/article/Chrome-v80-Cookie-Behavior-and-the-impact-on-MicroStrategy-Deployments?language=undefined&t=1581355581289>
        [python_venv]: <https://docs.python.org/3/tutorial/venv.html>
        [release_notes]: <https://github.com/MicroStrategy/mstrio-py/blob/master/NEWS.md>
        [logo]: <https://github.com/MicroStrategy/mstrio-py/blob/master/mstr-logo.png?raw=true>
        [example_conn]: <https://github.com/MicroStrategy/mstrio-py/blob/master/examples/connect.py>
        [example_import]: <https://github.com/MicroStrategy/mstrio-py/blob/master/examples/cube_report.py>
        [example_export]: <https://github.com/MicroStrategy/mstrio-py/blob/master/examples/create_dataset.py>
        [example_app]: <https://github.com/MicroStrategy/mstrio-py/blob/master/examples/application_mgmt.py>
        [example_server]: <https://github.com/MicroStrategy/mstrio-py/blob/master/examples/server_mgmt.py>
        [example_user]: <https://github.com/MicroStrategy/mstrio-py/blob/master/examples/user_mgmt.py>
        [example_subs]: <https://github.com/MicroStrategy/mstrio-py/blob/master/examples/subscription_mgmt.py>
        [example_library]: <https://github.com/MicroStrategy/mstrio-py/blob/master/examples/user_library.py>
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
