.. |nipy| image:: https://image.ibb.co/f0FRs0/nipy.png :height: 28px
Nifi-Python-Api: A rich Apache NiFi Python Client SDK
.. image:: https://img.shields.io/travis/Chaffelson/nipyapi.svg :target: https://travis-ci.org/Chaffelson/nipyapi :alt: Build Status
.. image:: https://readthedocs.org/projects/nipyapi/badge/?version=latest :target: https://nipyapi.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://pyup.io/repos/github/Chaffelson/nipyapi/shield.svg :target: https://pyup.io/repos/github/Chaffelson/nipyapi/ :alt: Python Updates
.. image:: https://coveralls.io/repos/github/Chaffelson/nipyapi/badge.svg?branch=master :target: https://coveralls.io/github/Chaffelson/nipyapi?branch=master&service=github :alt: test coverage
.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg :target: https://opensource.org/licenses/Apache-2.0 :alt: License
Three layers of Python support for working with Apache NiFi:
Please see the
issue <https://github.com/Chaffelson/nipyapi/issues>_ register for more information on current development.
| There are several scripts to produce demo environments in nipyapi.demo.** | The mid-level functionality is in nipyapi.canvas / nipyapi.security / nipyapi.templates / nipyapi.versioning | You can access the entire API using the low-level SDKs in nipyapi.nifi / nipyapi.registry*
The easiest way to install NiPyApi is with pip::
# in bash pip install nipyapi
You can set the config for your endpoints in the central config file::
# in python import nipyapi nipyapi.config.nifi_config.host = 'http://localhost:8080/nifi-api' nipyapi.config.registry_config.host = 'http://localhost:18080/nifi-registry-api'
Then import a module and execute tasks::
You can use the Docker demos to create a secured interactive console showing many features::
from nipyapi.demo.secured_console import * from nipyapi.demo.console import *
You can also explore the scripts to get ideas for how NiPyAPi can be used to automate your environment.
Please check out the
Contribution Guide <https://github.com/Chaffelson/nipyapi/blob/master/docs/contributing.rst>_ if you are interested in contributing to the feature set.
| For more information on Apache NiFi, please visit
| For Documentation on this package please visit
| Currently we are testing against NiFi versions 1.1.2 - 1.10, and NiFi-Registry versions 0.1.0 - 0.5.0.
| If you find a version compatibility problem please raise an
| Python 2.7 or 3.5-7 supported, though other versions may work. We will shortly stop supporting Python2 | Tested on AL2 and OSX 10.14.x - Windows automated testing not attempted | Outside of the standard Python modules, we make use of lxml, DeepDiff, ruamel.yaml and xmltodict in processing, and Docker for demo/tests.