Getting Started

Gettings started with presalytics.io should take around 15 minutes. There are a few guides to help you along along your way:

• Quick Start Guide

• Account Setup and Configuration

• Automated Story Editing in Python

For those who prefer to learn by doing, you can jump straight to the examples. A video walkthrough of the account setup and story creation process can be found below:

Quick Start Guide

Basic use of the presalytics API does not require any coding. To get started, select any presentation file (.pptx). This can be saved from Microsoft PowerPoint or downloaded from Google Slides.

This quick start assumes that you have already set up a presalytics account. You can sign up here.

To use presalytics, you will want to create a story via in the Story API. First, navigate to the story page, and click ont the "Add Story" button. See image below:



This button opens up a dialog box:



Click the "Browse" button and upload the example file that you selected. After the file is done uploading, the page will reload. You should now see your uploaded story in the table.

Click on the eyeball icon to view your story on the view page.

Click on the gear icon to view your story's settings. Scroll down to the "Share anc Collaborate" section and click the "Share With a Colleague" button. You can shared your new story with a friends and co-workers by entered their email address in the dialog box:



You can also embed your embed your stories and dashboards

TODO: Add user engagement metrics walkthrough

Now you're using the Presalytics API. See the steps below for instructions on how to build automation into your stories.

Account Setup

Before getting started with the Presalytics API, users need to create an account.

When signing up for a presalytics account, you will be prompted to fill out an "Account Type" dropdown menu.

If you plan of using Presalytics API or middleware for development of a client application, please sign up for a developer or account administation. This configures your account to that it can delegate authenication and operate in multi-user environments. >95% of users don't need this.

If at any point you need to change your account type, contact us and we will configure it for you.

Python Workspaces

Presalytics features' become much more powerful when scripting in python automate story updates via the Presalytics API.

Dependencies

• Python 3.5+: Download and install here

• (Windows only) Microsoft Visual C++ 14.0'. Absence of this package will cause the pip installer on windows to fail. Please install from this link and try to reinstall via pip. You may need to update upgrade setuptools as well.

For scripting, users typically set up a python virtual environment. Environments created using the Anaconda's conda create command and iPython environments are supported (e.g., jupyter notebooks.)

Setting Up a Workspace

To set up your. From the command line, install presalytics from the python package index:

pip install presalytics

The presalytics command line interface (CLI) becomes available. You can now issue commands to the presalytics API using presalytics .. (command). For a list of available commands, enter presalytics help.

Configuration

Configure you environment with the following command:

presalytics config {YOUR_USERNAME}

The config command creates a file named config.py in in the current working direction. This file contains a dictionary filled will configuration values. These values are used by the presalytics tools to that. For example, you could add you presalytics password to the dictionary with the PASSWORD key and the presalytics CLI and your scripts will automatically manage API logins for you. A full list of possible configuration values can be found in the configuration section of the python library specification

Please note that you using the presalytics CLI tool may be dependent on how you've set up your workspace. If you are not using a python virtual environment, you may have to prepend you commands with python -m help the your system's python interpreter find the presalytics module.

After settings up your python workspace, you are ready to start on the examples, which will guide you through the basics of building live presentations and dashboards via presalytics Stories.