Creating your Guardium application

Use the Guardium® GUI Application Framework SDK to create a basic development environment for your app. You can also build on one of the sample template apps that come with the SDK to create your own app.

Procedure

Create a folder on your computer for the Guardium sample app by entering the command grd_sdk create -w <path to myapp>, where <path to myapp> is the path to the local folder you want to create for your apps, for example: grd_sdk create -w ./myApp.

CAUTION:

Do not create your workspace under the SDK directory. Directories under SDK are deleted when you upgrade the SDK.

Note: Folder and file names in paths must not contain spaces.

Note: On Linux, keep the absolute path to your app short. File paths might be truncated due to the BINPRM_BUF_SIZE kernel constant (79 or 127 characters, depending on kernel version), leading to failure of this command.

Results

When you run the development environment script, the following folders and files are added to your app development folder.

Table 1. Guardium App files and folders in development folder
Files/Folders	Description
app	The main directory for application files. Contains the following files: The views.py file is the main entry point into the web app. This file and the manifest.json file are the only files that are required for every app. This file contains sample code for the "Hello World" application. The gpylib folder contains the Python library files that your app uses to perform Guardium operations. You can use the gpylib library to connect to API endpoints, get the storage path, and so on.
grd_appf_venv	Contains the Python virtual environment for running your app locally .
manifest.json	Describes what the sample "Hello World" app does.
src_deps	The src_deps folder contains the list of python dependencies used by application
grdlib	The grdlib folder contains the Python SDK grd api library, used by application. You can call the functions from grdapi library in views.py , for example for creating Guardium reports.
store	The store folder contains application storage files and application log files
run.py	Default Python script for running your app locally.

What to do next

You are now ready to begin coding your app. Familiarize yourself with the source dependencies for the app and manifest file structures.