There are two different options for setting up your system to make calls to the Akamai OPEN APIs. Either of these choices will let you make calls from the command line or using our code samples.

Install Using Docker

The first option is a docker container, which will do all of the setup for you. This is ideal if you don’t have a Python development environment on your system and don’t want to install a new programming language.

Install Locally

The second option is a local Python installation. If you’ve already got Python on your system this is definitely your best option. This section describes the steps needed to work with the APIs on the command line or using our sample code.


Docker

These instructions will help you to install our docker container on your system. The docker container has the following features:

  • Native client on Windows and OSX
  • Does not interfere with existing development environment
  • All setup and configuration is done automatically
  • Does not require git installation

Instructions

  1. Set up Docker on your system: Install Docker
  2. Install the Akamai Kickstart Container: docker run -it akamaiopen/api-kickstart

Once the container initializes, a welcome message appears telling you that you’ve started the container, followed by this prompt:

Akamai API Bootcamp >>

This indicates that the container is running and has placed you at a command prompt in the directory containing the sample application.

What’s Next:


Local Python Installation

You need the following tools in order to work with the APIs from your native OS:

Developer Tools:

Once you’re ready, you can either use HTTPie, a command-line utility, or pull the git repository and work with the code samples.


HTTPie

Note that even if you already have HTTPie installed, you need to install our custom authentication package, so please follow these instructions. It will not interfere with your current installation, just add another authentication option for OPEN APIs.

If you’ve installed Python 2.7.9 or later, you already have pip installed. You can install HTTPie using pip quite easily. If you don’t have pip already it’s relatively easy to install this package manager.

Global Install

$ sudo pip install httpie-edgegrid

User Install

$ pip install httpie-edgegrid --user

If you don’t have pip and don’t want to install it, grab the git repository. On Windows, use the gitshell terminal to run this command:

$ git clone https://github.com/akamai/httpie-edgegrid
$ cd httpie-edgegrid

Global Install

$ sudo python setup.py install

User Install

$ python setup.py install --user

What’s Next:


Code Samples

In Windows, start a gitshell session to run the following commands.

Navigate into the directory where you want your code to live.

Use git to clone the sample client into that directory:

$ git clone https://github.com/akamai/api-kickstart.git
Cloning into 'api-kickstart'...
remote: Counting objects: 29, done.
remote: Compressing objects: 100% (22/22), done.
remote: Total 29 (delta 7), reused 21 (delta 2)
Unpacking objects: 100% (29/29), done.
Checking connectivity... done

Navigate into the api-kickstart directory and verify that you have the package:

$ cd api-kickstart/
$ ls
Dockerfile    MOTD          contrib       sample_edgerc
LICENSE       README.md     examples

For this application, we will use the AkamaiOPEN-edgegrid-python client.

Global Install

$ cd examples/python
$ sudo python tools/setup.py install

User Install

$ cd examples/python
$ python setup.py install --user

If you have issues with this setup command, check this stack overflow issue.

What’s Next: