Development Guide

Welcome to the kibana-py development documentation. This section provides comprehensive information for contributors and maintainers.

Development

• Contributing to kibana-py
  • Code of Conduct
  • Getting Started
  • Development Setup
  • Development Workflow
  • Code Quality Standards
  • Documentation Guidelines
  • Submitting Changes
  • Review Process
  • Getting Help
  • Additional Resources
  • License
• Testing Guide
  • Testing Philosophy
  • Test Organization
  • Unit Testing
  • Integration Testing
  • Test Coverage
  • Performance Testing
  • Best Practices
  • Continuous Integration
  • Troubleshooting
  • Additional Resources
• Adding Space Support to New API Clients
  • Overview
  • Why Use NamespaceClient?
  • Step-by-Step Implementation Guide
  • Constructor Options
  • Best Practices
  • Testing Your Implementation
  • Complete Example
  • Additional Resources
• Release Process
  • Prerequisites
  • Version Numbering
  • Release Checklist
  • Step-by-Step Release Process
  • Troubleshooting
  • Security Considerations
  • Quick Reference Commands
  • Automation Considerations
  • Additional Resources
  • Support
• Architecture
  • Project Structure
  • Core Architectural Principles
  • Client Hierarchy
  • Key Design Patterns
  • Sync/Async Architecture
  • Observability Integration
  • Caching Strategy
  • Extension Points
  • Design Decisions
  • Performance Considerations
  • Testing Architecture
  • Future Considerations
  • Additional Resources

For Contributors

If you’re interested in contributing to kibana-py, start here:

• Contributing to kibana-py - Guidelines for contributing code, documentation, and tests

• Testing Guide - Testing patterns, requirements, and best practices

• Adding Space Support to New API Clients - How to add space support to new API clients

For Maintainers

Information for project maintainers:

• Release Process - Step-by-step guide for publishing releases

• Architecture - Project architecture and design decisions

Quick Links

• GitHub Repository

• Issue Tracker

• Pull Requests

Getting Help

• Questions: Open a discussion on GitHub

• Bugs: Open an issue with reproduction steps

• Features: Open an issue to discuss before implementing

• Chat: Open a GitHub Discussion