vivainsights

Overview

This is a Python package for analyzing and visualizing data from Microsoft Viva Insights.

Access to the Analyst Experience is required. With this library, you can generate visualizations and compute analyses in a way that adheres to the analysis best practices of the Viva Insights query outputs.

For the full package documentation, please see here. The vivainsights library is published on the Python Package Index (PyPi).

The API is designed to remain conceptually parallel with the R package so analysts can move between the two languages more easily.

Viva Insights metric and organizational-attribute columns can vary by query, product version, and language locale. The package therefore uses caller-supplied column names for these fields. Person queries consistently use PersonId and MetricDate for their identifier and observation-date columns.

Example visualization output from the library (create_rank()):

Installation

Install vivainsights from PyPI:

pip install vivainsights

Alternatively, install the development version from GitHub:

pip install "vivainsights @ git+https://github.com/microsoft/vivainsights-py.git"

See the Analyst Guide for importing evolving or localized schemas, the function discovery guide for choosing the right function for a task, and the R and Python API guide for cross-language examples.

AI agents can start from the machine-readable index at llms.txt.

Also check out our package cheat sheet for a quick glimpse of what vivainsights offers:

Related repositories

• Viva Insights R library
• Viva RMarkdown Report Marketplace
• Viva Insights Sample Code
• Viva Insights Zoom Integration
• Viva Insights OData Query Download
• Viva Insights R library (legacy)

Contributing

This project welcomes contributions and suggestions. For feature and complex bug fix contributions, it is recommended that you first discuss the proposed change with vivainsight’s maintainers before submitting the pull request. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

License

This library is licensed under the MIT License. For more information, please see the LICENSE file.