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.17.30.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

gmapi-1.17.30-py2.py3-none-any.whl (9.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file gmapi-1.17.30.tar.gz.

File metadata

  • Download URL: gmapi-1.17.30.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.15

File hashes

Hashes for gmapi-1.17.30.tar.gz
Algorithm Hash digest
SHA256 69018f6e0657531cef3455473c5476987a9656156bd321f29b2ca0f442c1ff32
MD5 3b942718206fbf603747235769cecab1
BLAKE2b-256 30324435e33ed6538df6dd033d9b28241684cb500de9fe670d25562507a2d216

See more details on using hashes here.

File details

Details for the file gmapi-1.17.30-py2.py3-none-any.whl.

File metadata

  • Download URL: gmapi-1.17.30-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.15

File hashes

Hashes for gmapi-1.17.30-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c782d9a009f80bbfbd01b39fc4a3da5020438b423b023e6233e3e29e4adbc609
MD5 c4e12e7fbc8e5010701175769052d338
BLAKE2b-256 7adcc353b9b7bf4c6abe92a5192308965bd5e72130f8ee74c81244750a26adbb

See more details on using hashes here.

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