Cassiopeia requires Python 3.6 and we highly recommend installing Anaconda with Python 3.6.
Install using pip¶
pip install cassiopeia to get the latest release. (See the pip install page if you do not have
pip installed.) If you want to pull the most recent version, you can install directly from GitHub using
pip install git+https://github.com/meraki-analytics/cassiopeia.git instead. We may not make a PyPy release (which
pip usually pulls from) for small changes to the code.
You may have some issues during installation due to PyCurl. Try the installation first, and if you have issues with pycurl come back and read this section. If Cass installed properly but is throwing certificate errors, skip to the 3rd paragraph.
At the moment PyCurl does not fully support installation with Python 3.6 and many people have had issues. The easiest thing to do (and what we highly recommend) is to install Python 3.6 via Anaconda. Anaconda is a package manager for Python and provides many packages that are difficult to install without Anaconda. If you do not or can’t use Anaconda, you’ll need download and install Curl, then use
easy_install to install PyCurl and link it to the proper Curl libraries. This isn’t much fun, and again we recommend Anaconda to ease the process.
If you successfully installed Cass but it’s throwing a certificate error, you probably just need to
pip install certifi. This should solve any certificate errors.
If you are having more problems, let us know via the Riot API discord server or our Meraki discord server.
Alternative library support¶
In case PyCurl is not installed, Cassiopeia falls back to Requests, this is a direct dependency and the user is not required to install the library manually.
# see https://github.com/psf/requests/issues/1595#issuecomment-504030697 for more details import requests import ujson requests.models.complexjson = ujson
Install from Source¶
If you would like to get Cassiopeia with the most recent updates (even before they have been pushed in an official release), you can clone the repository. Go to Cassiopeia’s Github page and either download the zip or
git clone https://github.com/meraki-analytics/cassiopeia into a directory of your choice.
pip install -r requirements.txt in the newly downloaded cassiopeia directory to install the dependencies.
Next, add the newly downloaded cassiopeia source directory to your
PYTHONPATH environment variable. If a
PYTHONPATH environment variable does not exist on your system (which may be true if you have a newly installed version of python), you will need to create it.
On Windows, follow the instructions here. Note that if you need multiple paths on your
PYTHONPATH, you can separate them with a
On Mac or Linux, add
export PYTHONPATH=$PYTHONPATH:<CASSIOPEIA PATH> to the end of your shell rc file (this should be
~/.bashrc for most), where
<CASSIOPEIA PATH> is the path of the directory you cloned, or the cassiopeia.zip file you downloaded.
Restart your terminal/IDE.
Google can probably give you more information as well, and note that the path name you add your your
PYTHONPATH should end in
Setting Your API Key and Other Settings¶
By default, Cass pulls your API key from an environment variable called
RIOT_API_KEY. You can modify this behavior by calling
cass.set_riot_api_key(...) or by creating a your own configuration for Cass (see Settings for more info). However, we encourage new users to use Cass’s default configuration.
To create an environment variable on Windows, follow the directions here. On Linux or Mac, add
export RIOT_API_KEY='<YOUR_API_KEY>' to the end of your shell rc file (this should be
~/.bashrc for most), where
<YOUR_API_KEY> is your Riot-issued API key. Then restart your terminal/IDE.
Cass has plugins that enable additional functionality. See Plugins for more information about how to install each plugin.