Skip to content

Alignak-monitoring-contrib/alignak-backend-client

Repository files navigation

Alignak Backend client

Python client library and CLI for Alignak Backend

Develop branch build status Development code static analysis Development code coverage Lastest documentation Status Development documentation Status Most recent PyPi version Join the chat #alignak on freenode.net License AGPL v3

Documentation

The Backend client class is commented and an online documentation is automatically built from the source code. Click on this link or on one of the docs badges on this page to browse the documentation.

The Alignak backend documentation will also be really helpful to you ;)

Installation

From Alignak packages repositories

More information in the online Alignak backend documentation. Here is only an abstract...

Debian:

# Alignak DEB stable packages
sudo echo deb https://dl.bintray.com/alignak/alignak-deb-stable xenial main | sudo tee -a /etc/apt/sources.list.d/alignak.list
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv D401AB61

sudo apt-get update
sudo apt install python-alignak-backend-client

CentOS:

sudo vi /etc/yum.repos.d/alignak-stable.repo:
   [Alignak-rpm-stable]
   name=Alignak RPM stable packages
   baseurl=https://dl.bintray.com/alignak/alignak-rpm-stable
   gpgcheck=0
   repo_gpgcheck=0
   enabled=1

sudo yum repolist

sudo yum install python-alignak-backend-client

From PyPI

To install the package from PyPI:

sudo pip install alignak-backend-client

From source files

To install the package from the source files:

git clone https://github.com/Alignak-monitoring-contrib/alignak-backend-client
cd alignak-backend-client
sudo pip install .

Release strategy

Alignak backend and its satellites (backend client, and backend import tools) must all have the same features level. As of it, take care to install the same minor version on your system to ensure compatibility between all the packages. Use 0.4.x version of Backend import and Backend client with a 0.4.x version of the Backend.

Bugs, issues and contributing

Contributions to this project are welcome and encouraged ... issues in the project repository are the common way to raise an information.