Metadata-Version: 2.1
Name: aio-ipfabric
Version: 0.16.0
Summary: Python asyncio client for IP Fabric
Home-page: UNKNOWN
Author: Jeremy Schulman
License: UNKNOWN
Description: # Python Asyncio Client for IP Fabric
        
        This package contains a Python 3.8+ asyncio client for use wih the IP Fabric product.
        
           * About IP Fabric: https://ipfabric.io/
           * About IP Fabric API: https://docs.ipfabric.io/api/
        
        
        [![Downloads](https://pepy.tech/badge/aio-ipfabric)](https://pepy.tech/project/aio-ipfabric)
        ![Supported Python Version](https://img.shields.io/pypi/pyversions/aio-ipfabric)
        ![Contributors](https://img.shields.io/github/contributors/jeremyschulman/aio-ipfabric)
        [![License](https://img.shields.io/github/license/jeremyschulman/aio-ipfabric)](https://github.com/jeremyschulman/aio-ipfabric/blob/main/LICENSE)
        
        
        # Installating aio-ipfabric and supported versions
        
        aio-ipfabric is available on [PyPI](https://pypi.org/project/aio-ipfabric/):
        
        ```shell script
        pip install aio-ipfabric
        ```
        
        Direct installation
        ```shell script
        pip install git+https://github.com/jeremyschulman/aio-ipfabric@master#egg=aio-ipfabric
        ```
        
        Requests officially supports Python 3.8+.
        
        
        # Quick Start
        
        ````python
        import asyncio
        from aioipfabric import IPFabricClient
        
        loop = asyncio.get_event_loop()
        
        # create a client using environment variables (see next section)
        ipf = IPFabricClient()
        
        # alternatively create instance with parameters
        # ipf = IPFabricClient(base_url='https://myipfserver.com', username='admin', password='admin12345')
        # ipf = IPFabricClient(base_url='https://myipfserver.com', token='TOKENFROMIPF')
        
        # login to IP Fabric system
        loop.run_until_complete(ipf.login())
        
        # fetch the complete device inventory
        device_list = loop.run_until_complete(ipf.fetch_devices())
        
        # close asyncio connection, otherwise you will see a warning.
        loop.run_until_complete(ipf.logout())
        ````
        
        ## Environment Variables
        
        The following environment variable can be used so that you do no need to provide them in
        your program:
        
           * `IPF_ADDR` - IP Fabric server URL, for example "https://my-ipfabric-server.com/"
           * `IPF_USERNAME` - Login username
           * `IPF_PASSWORD` - Login password
           * `IPF_TOKEN` - A persistent API token
        
        You can use either the login credentials or the token to login.
        
        If you prefer not to use environment variables, the call to `IPFabricClient()` accepts
        parameters; refer to the `help(IPFabricClient)` for details.
        
        # Documentation
        
        See the [docs](docs) directory.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Networking
Description-Content-Type: text/markdown
