Skip to main content

appkit-commons

Python 3.13+ License: MIT

Shared utilities and infrastructure for AppKit components.

appkit-commons provides the foundational infrastructure used across all AppKit packages, including configuration management, database integration, logging, security utilities, and dependency injection. It serves as the common base layer that enables consistent behavior and shared functionality across the AppKit ecosystem.


✨ Features

  • Configuration Management - YAML-based configuration with environment variable overrides and secret handling
  • Database Integration - SQLAlchemy-based ORM with PostgreSQL support, connection pooling, and encryption
  • Logging Infrastructure - Structured logging with color output and configurable levels
  • Security Utilities - Password hashing with PBKDF2 and scrypt, secure random generation
  • Service Registry - Dependency injection container for managing application services
  • Secret Management - Support for local secrets and Azure Key Vault integration

🚀 Installation

As Part of AppKit Workspace

If you're using the full AppKit workspace:

git clone https://github.com/jenreh/appkit.git
cd appkit
uv sync

Standalone Installation

Install from PyPI:

pip install appkit-commons

Or with uv:

uv add appkit-commons

Optional Dependencies

For Azure Key Vault support:

pip install appkit-commons[azure]
# or
uv add appkit-commons[azure]

Dependencies

  • colorlog>=6.9.0 (colored logging)
  • cryptography>=46.0.2 (encryption utilities)
  • pydantic-settings>=2.10.1 (configuration management)
  • pyyaml==6.0.2 (YAML configuration)
  • sqlalchemy-utils==0.42.0 (database utilities)
  • sqlalchemy==2.0.41 (ORM)

🏁 Quick Start

Basic Configuration

Create a configuration class extending BaseConfig:

from appkit_commons.configuration import BaseConfig


class MyConfig(BaseConfig):
    app_name: str = "MyApp"
    debug: bool = False
    api_key: str = "secret:api_key"  # Will be resolved from secrets

Load configuration from YAML and environment:

from appkit_commons.configuration import load_configuration

config = load_configuration(MyConfig, "config.yaml")
print(f"App: {config.app_name}, Debug: {config.debug}")

Database Setup

Configure database connection:

from appkit_commons.database import DatabaseConfig, create_session_manager

db_config = DatabaseConfig(
    type="postgresql",
    host="localhost",
    port=5432,
    name="myapp",
    username="user",
    password="secret:db_password",
)

session_manager = create_session_manager(db_config)

# Use in your code
with session_manager.session() as session:
    # Your database operations
    pass

Logging Setup

Initialize logging with configuration:

from appkit_commons.configuration import setup_logging

# Setup with default configuration
setup_logging()

# Or with custom config
setup_logging(log_level="DEBUG", log_file="app.log")

📖 Usage

Configuration System

BaseConfig

All configuration classes should inherit from BaseConfig:

from appkit_commons.configuration import BaseConfig


class AppConfig(BaseConfig):
    model_config = {"env_prefix": "MYAPP_"}

    database_url: str = "postgresql://localhost/mydb"
    api_timeout: int = 30
    features: dict[str, bool] = {"new_ui": True}

Secret Resolution

Use secret: prefix for sensitive values:

class SecureConfig(BaseConfig):
    api_key: str = "secret:openai_api_key"  # Resolved from env or Key Vault
    db_password: str = "secret:database_password"

YAML Configuration

Configuration files support nested structures:

# config.yaml
app:
  name: "MyApp"
  database:
    host: "localhost"
    port: 5432
  features:
    - "authentication"
    - "file_upload"

Database Integration

Session Management

Use the session manager for database operations:

from appkit_commons.database import create_session_manager

manager = create_session_manager(db_config)

# Get a session
with manager.session() as session:
    # Perform operations
    result = session.execute(text("SELECT 1"))
    print(result.scalar())

Entity Base Classes

Extend from BaseEntity for common database fields:

from appkit_commons.database import BaseEntity
from sqlalchemy import Column, String


class User(BaseEntity):
    __tablename__ = "users"

    email = Column(String, unique=True, nullable=False)
    name = Column(String, nullable=False)

Security Utilities

Password Hashing

from appkit_commons.security import hash_password, verify_password

# Hash a password
hashed = hash_password("mypassword")

# Verify a password
is_valid = verify_password("mypassword", hashed)

Secure Random Generation

from appkit_commons.security import generate_token

token = generate_token(length=32)

Service Registry

Dependency Injection

Register and retrieve services:

from appkit_commons.registry import service_registry

# Register a service
service_registry.register(MyService())

# Retrieve a service
service = service_registry.get(MyService)

🔧 Configuration

Environment Variables

Configuration supports nested environment variables:

export MYAPP_APP__NAME="ProductionApp"
export MYAPP_DATABASE__HOST="prod-db.example.com"
export MYAPP_API__TIMEOUT="60"

Azure Key Vault

For production secrets, configure Azure Key Vault:

from appkit_commons.configuration import configure_azure_key_vault

configure_azure_key_vault(
    vault_url="https://myvault.vault.azure.net/",
    credential=None,  # Uses DefaultAzureCredential
)

Logging Configuration

Customize logging output:

from appkit_commons.configuration import setup_logging

setup_logging(
    level="INFO",
    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
    file="app.log",
    max_file_size="10 MB",
    backup_count=5,
)

📋 API Reference

Configuration

  • BaseConfig - Base class for all configuration objects
  • load_configuration() - Load configuration from YAML and environment
  • setup_logging() - Initialize logging system
  • configure_azure_key_vault() - Setup Azure Key Vault integration

Database

  • DatabaseConfig - Database connection configuration
  • create_session_manager() - Create database session manager
  • BaseEntity - Base class for database entities

Security

  • hash_password() - Hash passwords with PBKDF2 or scrypt
  • verify_password() - Verify password against hash
  • generate_token() - Generate secure random tokens

Registry

  • service_registry - Global service registry instance
  • ServiceRegistry - Dependency injection container

🔒 Security

  • Passwords are hashed using industry-standard algorithms (PBKDF2/scrypt)
  • Database credentials support encryption at rest
  • Azure Key Vault integration for production secret management
  • Secure random generation for tokens and salts

🤝 Integration Examples

With AppKit Components

appkit-commons is automatically integrated into other AppKit packages:

# Configuration is inherited by appkit-user, appkit-assistant, etc.
from appkit_user.configuration import UserConfig

user_config = UserConfig()  # Extends BaseConfig automatically

Custom Application Setup

Complete application bootstrap:

from appkit_commons.configuration import load_configuration, setup_logging
from appkit_commons.database import create_session_manager
from appkit_commons.registry import service_registry

# Load config
config = load_configuration(MyAppConfig, "config.yaml")

# Setup logging
setup_logging(level=config.log_level)

# Setup database
db_manager = create_session_manager(config.database)
service_registry.register(db_manager)

# Your app logic here

Metadata

Release files for appkit-commons 1.16.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for appkit-commons 1.16.2
File Size Uploaded Provenance Actions
appkit_commons-1.16.2.tar.gz 61.6 kB Without provenance Details for appkit_commons-1.16.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for appkit-commons 1.16.2
File Interpreter ABI Platform Actions
appkit_commons-1.16.2-py3-none-any.whl Python 3 none any Details for appkit_commons-1.16.2-py3-none-any.whl

Total release size: 100.3 kB

Release files / appkit_commons-1.16.2.tar.gz

Download URL appkit_commons-1.16.2.tar.gz
Size 61.6 kB
Tags Source
SHA-256 checksum
How to use checksums
e064e6fa60860845a9f7e2c437e17c1bc904c0eb2939239839f6c40e7a975e60
BLAKE2b-256 checksum
How to use checksums
bf76f00d2180662e684c3bd74ac61e7d7217de3aedf865a1a0ffcf243598ee44
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / appkit_commons-1.16.2-py3-none-any.whl

Download URL appkit_commons-1.16.2-py3-none-any.whl
Size 38.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
137cc564bb49ed4d86ac276c7313a973f3665a6ff5e46f550e3c1f8d4a776d61
BLAKE2b-256 checksum
How to use checksums
f8424d757cdf807f44fa2d666f7e89896d8161b0b5e60f895b507ba6890d67ce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for appkit-commons 1.16.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.16.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page