https://github.com/viniarck/phpipam-pyclient

:gem: REST client and CLI tool to interface with phpipam REST API
https://github.com/viniarck/phpipam-pyclient

phpipam python rest-api

Last synced: about 2 months ago
JSON representation

:gem: REST client and CLI tool to interface with phpipam REST API

• Host: GitHub
• URL: https://github.com/viniarck/phpipam-pyclient
• Owner: viniarck
• License: apache-2.0
• Created: 2017-12-26T18:40:47.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-02-22T19:10:41.000Z (almost 3 years ago)
• Last Synced: 2024-02-14T21:26:52.665Z (11 months ago)
• Topics: phpipam, python, rest-api
• Language: Python
• Homepage:
• Size: 74.2 KB
• Stars: 15
• Watchers: 4
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![pipeline status](https://gitlab.com/viniarck/phpipam-pyclient/badges/master/pipeline.svg)](https://gitlab.com/viniarck/phpipam-pyclient/commits/master) [![Documentation Status](https://readthedocs.org/projects/phpipam-pyclient/badge/?version=latest)](http://phpipam-pyclient.readthedocs.io/en/latest/?badge=latest)

## phpipam-pyclient

![logo](./images/phpipampyclient.png)

phpipam-pyclient is a REST-client CLI tool to interface with [phpipam](https://github.com/phpipam/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.

## Installation

Currently, the only supported installation is directly via checking the code from GitHub. 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](http://phpipam-pyclient.readthedocs.io/).

### via GitHub

```

git clone https://github.com/viniarck/phpipam-pyclient.git

cd phpipam-pyclient

virtualenv -p python3 .venv

source .venv/bin/activate

pip install -e .

```

## Changelog

[CHANGELOG.md](./CHANGELOG.md)