HomeGuidesRecipesAPI EndpointsRelease NotesCommunity
Log In

Installing Prerequisites

You will need the following installed on your computer. Using the Terminal (see Setting Up Your Environment), install the following:

Python (3.0+)


General Note

These tutorials are not designed to teach you Python but having some basic understanding will help you along the way. However, these tutorials will provide you with all of the commands needed in order to operate the API. Think of it like attending a conference in another country where you are provided a phrasebook with just enough of the language to get you through the event.

Python is a programming language that you will use to communicate with the Vyasa Layar API.

We support Python 3.0+, which is not backwards compatible. To check what version (if any) of Python you have on your computer, run the following command in your Terminal.

python3 --version
python --version

If the console returns something along the lines of zsh: command not found: python, then you do not have Python 3 installed on your computer and you should proceed to the next step.

In order to use Python on your computer, you will need to install a compiler that can translate the Python commands into something the computer can understand.

You can download the installation manager for the Python compiler from www.python.org/downloads or if you are on a Mac and have Homebrew installed run the following command in your Terminal:

brew install python3


Add Python to PATH

If you are using the download from the Python website, make sure you select "Add to PATH" in the installer window

Confirm you now have Python 3.x using the same version command as before:

python3 --version

You should see a response along the lines of Python 3.9.12 in your console. Python 3.0 and up is compatible!


Make sure you have PIP installed. It should come with your Python download. PIP is a Python package manager that will allow you to install the Layar API into your project.

You can make sure it’s available in your terminal by running:

pip3 -V

If you don’t have pip installed you can install the latest version of pip by running the following command:

python3 -m ensurepip --upgrade


Python and PIP Installed!

You now have the python language, and a package manager to download, update, and maintain your dependencies. Now it's time to import these dependencies, including the Layar API package.

Up Next

Learn how to install the Layar API, create a project in VSCode, and import dependencies into your project.