Skip to main content

Python bindings to Graymeta.com Platform API v.21+

Project description

# gm

Python GrayMeta API bindings.

This project is used to access your GrayMeta installation API using python.

## Installation

This is avaialble on pypy

pip install gmapi

## Usage

`gmapi` can be used directly via the terminal with the `gm` command, or via the API.

## Usage (Terminal)

You must first make the `GRAYMETA_SERVER_URL` and your `GRAYMETA_API_KEY` available as environment variables, then you can call `gm`

```
export GRAYMETA_SERVER_URL=https://your-installation-of-graymeta
export GRAYMETA_API_KEY=your-api-keye
```

> See your Admin for details of these values

Next, you can just call `gm`:

```
gm
```

## Usage (API)

Having installed gmapi via `pip`, you can then use it directly in your python, for example

(demo.py)

```
from gmapi import gmapi.GraymetaClient

SERVER_URL="https://your-server"
API_KEY="your-gm-api-key"
client = GraymetaClient(SERVER_URL, API_KEY)
client.search()
```

## API Documentation

TODO









Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gmapi-1.9.21.tar.gz (5.4 kB view hashes)

Uploaded Source

Built Distribution

gmapi-1.9.21-py2.py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page