This directory contains practical examples demonstrating NiPyAPI usage patterns and best practices.
fdlc.py - Flow Development Lifecycle
Purpose: Complete iterative workflow for enterprise NiFi development using NiFi Registry version control.
What it demonstrates:
- DEV → PROD flow promotion patterns
- Registry-based version control
- Multi-environment workflow management
- Enterprise development best practices
Usage: python examples/fdlc.py
sandbox.py - Multi-Profile Environment Setup
Purpose: Comprehensive authentication and environment setup across all supported profile types.
What it demonstrates:
- Multi-profile authentication (single-user, secure-ldap, secure-mtls, secure-oidc)
- SSL/TLS configuration and certificate handling
- Security policy bootstrapping for secure environments
- Registry client setup with Docker networking
- Sample object creation (buckets, flows, versioning)
Usage: python examples/sandbox.py <profile> or make sandbox NIPYAPI_PROFILE=single-user from project root.
Supported profiles: single-user, secure-ldap, secure-mtls, secure-oidc
profiles.yml - Configuration Template
Purpose: Example configuration file showing all supported authentication methods and settings.
What it contains:
- Complete profile configuration examples
- Authentication method templates
- SSL/TLS configuration patterns
- Environment variable override examples
Usage: Copy and modify for your own environments, then use with nipyapi.config.default_profiles_file = 'path/to/your/profiles.yml'
- For new users: Start with the Docker-based quick start in the main README, then try
sandbox.py - For enterprise workflows: Study
fdlc.pyfor development lifecycle patterns - For configuration: Use
profiles.ymlas a template for your environments
For complete API documentation and detailed guides, see:
- Profiles Documentation - Configuration and authentication
- Security Documentation - SSL/TLS and authentication setup
- Migration Guide - Upgrading from 0.x to 1.x