Skip to main content

Alignak REST backend client library

Project description

This module is a Python library used for the REST API of the Alignak backend
Author: Alignak team
License: GNU Affero General Public License, version 3
Description: Alignak Backend client

*Python client library and CLI for Alignak Backend*

.. image::
:alt: Develop branch build status

.. image::
:alt: Development code static analysis

.. image::
:alt: Development code coverage

.. image::
:alt: Lastest documentation Status

.. image::
:alt: Development documentation Status

.. image::
:alt: Most recent PyPi version

.. image::
:alt: Join the chat #alignak on

.. image::
:alt: License AGPL v3


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 ;)


From Alignak packages repositories

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


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

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


sudo vi /etc/yum.repos.d/alignak-stable.repo:
name=Alignak RPM stable packages

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
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.

Keywords: alignak monitoring backend
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Systems Administration

Project details

Download files

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

Files for alignak_backend_client, version 1.4.2
Filename, size File type Python version Upload date Hashes
Filename, size alignak_backend_client-1.4.2-py3-none-any.whl (20.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size alignak_backend_client-1.4.2.tar.gz (62.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page