Skip to main content

Nifi-Python-Api: A convenient Python wrapper for the Apache NiFi Rest API

Project description

NiPyApi

Nifi-Python-Api: A convenient Python wrapper for the Apache NiFi Rest API

Release Status Build Status Documentation Status Python Updates test coverage License

Features

This package provides two main areas of functionality:
  • high-level calls to execute common NiFi tasks:
    • ./nipyapi/canvas.py etc.

  • a full swagger 2.0 compliant NiFi Rest API interface and Datamodels:
    • ./nipyapi/swagger_client/apis/flow_api.py etc.

    • ./nipyapi/swagger_client/models/process_group_entity.py etc.

Background

For more information on Apache NiFi, please visit https://nifi.apache.org
For Documentation on this package please visit https://nipyapi.readthedocs.io.

Version Support

Supports NiFi version: 1.2.x
If you require a different version please raise an issue

Requirements

Python 2.7 or 3.6 supported, though other versions may work

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Inspired by the equivalent Java client maintained over at hermannpencole/nifi-config

The swagger 2.0 compliant client auto-generated using the Swagger Codegen project, and then cleaned / bugfixed by the authors.

History

0.4.0 (2017-10-29)

  • Added wrapper functions for many common Template commands (templates.py)

  • Added new functions for common Process Groups commands (canvas.py)

  • Significant test framework enhancements for wrapper functions

  • Many coding style cleanups in preparation for filling out test suite

  • Added linting

  • Cleaned up docs layout and placement within project

  • Integrated with TravisCI

  • Dropped Python2.6 testing (wasn’t listed as supported anyway)

  • Updated examples and Readme to be more informative

0.3.2 (2017-09-04)

  • Fixed bug where tox failing locally due to coveralls expecting travis

  • Fixed bug where TravisCI failing due to incorrectly set install requirements

  • Fixed bug where swagger_client not importing as expected

0.3.1 (2017-09-04)

  • Fixed imports and requirements for wheel install from PyPi

0.3.0 (2017-09-04)

  • Created basic wrapper structure for future development

  • Added simple usage functions to complete todo task

  • Added devnotes, updated usage, and various sundry other documentation cleanups

  • Split tests into subfolders for better management and clarity

  • Added Coveralls and License Badge

  • Removed broken venv that ended up in project directory, added similar to ignore file

  • Changed default URL in the configuration to default docker url and port on localhost

0.2.1 (2017-08-26)

  • Fixed up removal of leftover swagger client dependencies

0.2.0 (2017-08-25)

  • Merge the nifi swagger client into this repo as a sub package
    • Restructured tests into package subfolders

    • Consolidate package configuration

    • Setup package import structure

    • Updated usage instructions

    • Integrate documentation

0.1.2 (2017-08-24)

  • Created basic integration with nifi-python-swagger-client

0.1.1 (2017-08-24)

  • Cleaned up base project and integrations ready for code migration

0.1.0 (2017-08-24)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nipyapi-0.5.0.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

nipyapi-0.5.0-py2.py3-none-any.whl (425.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file nipyapi-0.5.0.tar.gz.

File metadata

  • Download URL: nipyapi-0.5.0.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nipyapi-0.5.0.tar.gz
Algorithm Hash digest
SHA256 4b57da0d96edfe1bcca6ba4b458b9bf3f1115aeb3060a4c7fa493bf342a8cbd7
MD5 1cbb948ddd7949ab9042963435f7e5b2
BLAKE2b-256 0c2e70f0efcf17ead1fdeac8dd6967efae0a4ceeb8394d85758a5b036676c5a7

See more details on using hashes here.

File details

Details for the file nipyapi-0.5.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for nipyapi-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f1b25096664119f5d153732953c89e8616d303aa5de670d2f30604339322621b
MD5 2d3143a15441ad4e6d283276a93e44d6
BLAKE2b-256 183da0455b6815f3d818a28bb5edcab0c55270d15a60327006259d022859d2c9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page