Metadata-Version: 2.1
Name: piexin
Version: 1.0.2
Summary: phpipam export to ansible inventory ini file
Home-page: http://github.com/aufbaubank/piexin
Author: Daniel Henneberg
Author-email: daniel.henneberg@aufbaubank.de
License: MIT
Description: # piexin
        
        [![Build Status](https://travis-ci.com/aufbaubank/piexin.svg?branch=master)](https://travis-ci.com/aufbaubank/piexin)
        [![codecov](https://codecov.io/gh/aufbaubank/piexin/branch/master/graph/badge.svg)](https://codecov.io/gh/aufbaubank/piexin)
        ![PyPI](https://img.shields.io/pypi/v/piexin)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/piexin)
        ![PyPI - License](https://img.shields.io/pypi/l/piexin)
        ![PyPI - Format](https://img.shields.io/pypi/format/piexin)
        ![PyPI - Wheel](https://img.shields.io/pypi/wheel/piexin)
        
        The **P**hp**I**pam **Ex**port **In**ventory for Ansible Inventory files.
        
        ## goals
        
        This code can be used to export your phpipam data to an ansible inventory file.
        
        - keep all data in one file
        - one command, one task
        
        ## quickstart
        
        ### phpIPAM
        
        * add an api account and get the api token for your app
        * assign permissions
        * set security to ssl with app token
        
        ![api key](resources/new_api_key.png "add api key")
        
        
        * add a custom field to store your ansible groups
        
        ![custom_field](resources/custom_field.png "custom field")
        
        ### run piexin
        
        Either store your api key to the environment variable named `PHPIPAM_TOKEN`
        or provide the token in the commandline
        
        minimal command:
        ```
        piexin -u https://phpipam.example.com --app piexin
        ```
        
        # complete help
        ```
        usage: piexin [-h] [-u url] [-t token] [-a app] [-c certificate] [-o output]
                      [-V] [-v]
        
        optional arguments:
          -h, --help            show this help message and exit
          -u url, --url url     url of phpipam server api, defaults to
                                http://localhost
          -t token, --token token
                                api token, can also be stored in environment variable
                                PHPIPAM_TOKEN
          -a app, --app app     phpipam api appname
          -c certificate, --cert certificate
                                ssl cert from server if server is not trusted
          -o output, --output output
                                file to print inventory to
          -V, --version         print version
          -v, --verbose
        ```
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
