kiarina-lib-atlassian 1.37.0

Atlassian API integration with configuration management

kiarina-lib-atlassian

Atlassian API integration with configuration management using pydantic-settings-manager.

Purpose

kiarina-lib-atlassian provides a simple and secure way to manage Atlassian API credentials (Jira, Confluence, etc.) using pydantic-settings-manager. This library enables the implementation of Atlassian-related functionality by separating and managing API credentials from the application.

Installation

pip install kiarina-lib-atlassian

Quick Start

from kiarina.lib.atlassian import settings_manager

# Configure Atlassian credentials
settings_manager.user_config = {
    "jira": {
        "url": "https://your-domain.atlassian.net",
        "username": "[e-mail]",
        "password": "your-api-token"
    }
}

# Get settings
settings = settings_manager.get_settings("jira")
print(f"Jira URL: {settings.url}")
print(f"Username: {settings.username}")
# Access API token securely
api_token = settings.password.get_secret_value()

API Reference

AtlassianSettings

Configuration settings for Atlassian API.

Fields:

• url: str - API endpoint URL (e.g., "https://your-domain.atlassian.net")
• username: str - Atlassian account email address
• password: SecretStr - Atlassian API token (stored securely)

Example:

from pydantic import SecretStr
from kiarina.lib.atlassian import AtlassianSettings

settings = AtlassianSettings(
    url="https://example.atlassian.net",
    username="[e-mail]",
    password=SecretStr("your-api-token")
)

settings_manager

Global settings manager instance for Atlassian API configuration.

Type: SettingsManager[AtlassianSettings]

Multi-configuration support: Enabled (can manage multiple Atlassian instances)

Example:

from kiarina.lib.atlassian import settings_manager

# Configure multiple instances
settings_manager.user_config = {
    "jira": {
        "url": "https://jira.example.com",
        "username": "[e-mail]",
        "password": "jira-token"
    },
    "confluence": {
        "url": "https://confluence.example.com",
        "username": "[e-mail]",
        "password": "confluence-token"
    }
}

# Get specific configuration
jira_settings = settings_manager.get_settings("jira")
confluence_settings = settings_manager.get_settings("confluence")

Configuration

YAML Configuration

# config/production.yaml
kiarina.lib.atlassian:
  jira:
    url: "https://your-domain.atlassian.net"
    username: "[e-mail]"
    password: "${ATLASSIAN_API_TOKEN}"
  
  confluence:
    url: "https://your-domain.atlassian.net"
    username: "[e-mail]"
    password: "${ATLASSIAN_API_TOKEN}"

Environment Variables

Settings can be configured via environment variables with the prefix KIARINA_LIB_ATLASSIAN_:

export KIARINA_LIB_ATLASSIAN__JIRA__URL="https://your-domain.atlassian.net"
export KIARINA_LIB_ATLASSIAN__JIRA__USERNAME="[e-mail]"
export KIARINA_LIB_ATLASSIAN__JIRA__PASSWORD="your-api-token"

Bootstrap Pattern

For multi-module applications, use the bootstrap pattern:

# bootstrap.py
import yaml
from pydantic_settings_manager import load_user_configs

def bootstrap():
    with open("config/production.yaml") as f:
        config = yaml.safe_load(f)
    load_user_configs(config)

# main.py
from bootstrap import bootstrap
from kiarina.lib.atlassian import settings_manager

bootstrap()
settings = settings_manager.get_settings("jira")

Testing

# Run tests
pytest

# Run tests with coverage
pytest --cov=kiarina.lib.atlassian --cov-report=html

Dependencies

• pydantic (>=2.10.5): Data validation and settings management
• pydantic-settings (>=2.7.1): Settings management from various sources
• pydantic-settings-manager (>=2.3.0): Advanced settings management with multi-configuration support

License

This project is licensed under the MIT License - see the LICENSE file for details.

Related Projects

• kiarina-python - Parent monorepo
• pydantic-settings-manager - Settings management library