phpipam-pyclient is a REST-client CLI tool to interface with phpipam REST API. phpipam-pyclient leverages python fire and requests under the hood, some high level functions have been implemented to allow the user to quickly query certain information about the devices on phpipam. In addition, you can use this library to build your Ansible inventory by filtering a field/column of the devices on phpipam.
Integration tests are implemented with pytest validating both Python3.6 and Python2.7 on a docker-based environment, in two stages:
- installation: validates a phpipam installation from strach with selenium.
- client-server API: validates phpipam-pyclient with phpipam REST client.
The following versions of phpipam are being tested on GitLab CI:
- 1.4 (latest as of now)
- 1.3.1
- 1.3
You have two options, either via the source code on Github or Docker. After completing the installation, you have to configure the parameters to authenticate your user on phpipam in the phpipam_pyclient/config.json file. You can find more information, examples and usage on ReadTheDocs.
git clone https://github.com/viniarck/phpipam-pyclient.git
cd phpipam-pyclient
pip install -e .
docker run -i -t -d --name phpipam-pyclient registry.gitlab.com/viniarck/phpipam-pyclient:dev
docker exec -i -t phpipam-pyclient /bin/bash -c 'phpipam-pyclient'