README.rst

centra-py-client

Python client for Centra API access. Visit Guardicore's website for more information about Centra!

Find the full client documentation at https://centra-py-client.readthedocs.io (locally, /docs folder).

Quick start guide

Installation

Released version

To install centra-py-client, run this command in your terminal:

$ pip install centra_py_client

This is the preferred method to install centra-py-client, as it will always install the most recent released version.

If you don't have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for centra-py-client can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/guardicode/centra_py_client

Or download the tarball:

$ curl -OJL https://github.com/guardicode/centra_py_client/tarball/main

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

First, create a CentraClient:

from centra_py_client import CentraClient, CentraSession
client = CentraClient(CentraSession("my.centra.address", "username", "password"))

Then use the client to interact with Centra, e.g.:

client.delete_label_by_name("Environemnt: TemporaryEnv")

Stability status

This package is currently considered unstable and there is no backward compatibility guaranteed.

This status will continue as long as the package is in the 0.x.y versions. When the package stabilizes and we can guarantee backward compatibility, version 1.0.0 will be released.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.