InstallationΒΆ

To use the APPS library you need two things. First, a settings file which tells the library how to find the APPS WebService and how to authorize the requests the library makes against your user account. The contents of this file will look something like this:

{
    "portal": "http://pppx.gdgps.net",
    "api_path": "api/user",
    "key": "50052f46-bb9e-11e8-b79c-60f81dca17e2",
    "secret": "UkdjcmBsCl1oWScwbCJVW3N4MyMKXld4R3BLVVsoZDM="
}

Your settings file is accessible from here as well as from your account profile page, though you must be logged in to access it. Once you download it, the library needs to know where to find it. By default the library will look for ~/.apps_settings. If you prefer to locate the file elsewhere you may point the library to it via an initialization parameter or as a command line option when using the bundled scripts.

Caution

Your settings file contains your private secret which can be used to make WebService calls against your APPS account. It is very important to keep this file private and secure. If you work in a shared environment it is a best practice to make sure your settings file is only readable by your user account! If you think your settings file or account has been compromised for any reason you can change your password and reset your credential.

The second thing you need is the library itself. You can download the library or install it via pip:

$ pip install https://pppx.gdgps.net/static/lib/gdgps-apps-1.0.0b0.tar.gz