Quickstart

To authenticate to Shimoku API you need a Bearer Token that will be provided by your Sales Representative. If you still do not have it you can email to [email protected] or [email protected].
To use Shimoku’s API first install our SDK library
You can clone it from: 
​https://bitbucket.org/shimoku-tech/shimoku-api-python/src/devel/ 
or see it from github at:
​https://github.com/shimoku-tech/shimoku-api-python​
And in your Python +3.6 install it
pip install shimoku-api-python 
Once you have your token authentication is as easy as follows:
from os import getenv
import shimoku_api_python as Shimoku
​
access_token = getenv('SHIMOKU_TOKEN')  # env var with your token
universe_id: str = getenv('UNIVERSE_ID')  # your universe UUID
​
shimoku = Shimoku.Client(    
    config={'access_token': access_token},
    universe_id=universe_id,
)
And your Shimoku instance is ready to interact with the API and build new Analytics Progressive Web App
By default your instance is pointing to staging environment. Staging is intended to try iterations for some of your businesses. To work over production you can invoke your instance specifying the environment production:
from os import getenv
import shimoku_api_python as Shimoku
​
access_token = getenv('SHIMOKU_TOKEN')  # env var with your token
universe_id: str = getenv('UNIVERSE_ID')  # your universe UUID
​
shimoku = Shimoku.Client(    
    config={'access_token': access_token},
    universe_id=universe_id,
    environment='production',
)
Fast like in Plotly, but independent of IT with Shimoku
What in Plotly would be equivalent to
import plotly.express as px
long_df = px.data.medals_logn() fig = px.bar(long_df, x="nation", y="count", color="medal", title="Long-Form Input")
pyfig.show()
In Shimoku much more is done with the same code 🪄
​
from os import getenv
import shimoku_api_python as Shimoku
​
access_token = getenv('SHIMOKU_TOKEN')  
universe_id: str = getenv('UNIVERSE_ID') 
business_id: str = getenv('BUSINESS_ID')
​
shimoku = Shimoku.Client(    
    config={'access_token': access_token},
    universe_id=universe_id,
)
shimoku.plt.set_business(business_id)
​
report: Dict = shimoku.plt.bar(
  df, x='date', y=['billing'], 
  menu_path='catalog/bar-example', 
  order=0,
)
With the following critical differences:
Shimoku creates a PWA in the internet with all the Access Control, Menu and React components.
Shimoku takes care of all the Back-End, Front-End and DevOps of your Data App and you just focus in use your data to create analytics as in Plotly but creating a DataApp directly!
With an unlimited number of users
More on creating new users on Creating users.
​

Getting started - Previous

What is Shimoku?

Next - Building Data Apps

Overview

Last modified 3mo ago

Copy link