Aloha
aloha-python is a modern project template (boilerplate) and a versatile utility library (aloha package) designed to build robust, containerized microservices in Python.
Please generously STAR★ our project or donate to us!
-
To understand the package, read the 📚docs or
-
To contribute or talk to a human:
🚀 Key Features
- Configuration Management (
aloha.config): Lazy-loaded settings (SETTINGS) using HOCON (Human-Optimized Config Object Notation), supporting environment profile overrides (PROFILE_ENV/FILES_CONFIG, with legacyENV_PROFILEdeprecated) and environment variable injection. - Concurrent-Safe Logging (
aloha.logger): Multi-process safe daily rotating log file handler, console output, and automatic log paths configuration. - Database Operators (
aloha.db): Pre-built SQLAlchemy-backed connections for PostgreSQL, MySQL, SQLite, DuckDB, MongoDB, Redis, Elasticsearch, and Kafka, with password resolution via a securePasswordVaultwrapper. - Encryption & Utilities (
aloha.encrypt): Fast helpers for AES (ECB/CBC) encryption, RSA asymmetric key-pair generation/signatures, JWT encoding/decoding, and Base62 hashing. - Testing Harness (
aloha.testing): ExtendedUnitTestCaseand integrationServiceTestCasestructures for testing HTTP endpoints. - Binary Code Protection (
aloha compile): Utility compiler using Cython to package python source files (.py) into platform-native compiled dynamic libraries (.so/.pyd), protecting intellectual property.
📁 Repository Layout
src/: Application-specific codebase, configuration files (src/resource/config/), and unit/integration tests (src/tests/).pkg/: The corealohautility library source code.tool/: Local CI/CD files and setup helpers (e.g. docker-compose configurations, lifecycle scripts).doc/: Documentation files and AI Agent Skills.notebook/: Jupyter notebooks for interactive analysis.
🛠️ Local Development Quick Start
Local development is fully containerized using Docker & Docker Compose to maintain environment consistency.
1. Launch Dev Container
Run the lifecycle helper script:
# Check port availability and spin up the development container
./tool/cicd/run-dev.sh up
# Open an interactive terminal inside the container
./tool/cicd/run-dev.sh enter
Note: Development ports (PORT_APP and PORT_WEB) are dynamically computed based on your User ID (UID) to avoid conflicts on shared servers.
2. Run Tests
Inside the running container terminal:
# Execute pytest suite
pytest src/
# Run tests with code coverage report
pytest --cov=src src/
3. Production Packaging
To build a production-ready Docker image with optional binary compilation enabled:
source tool/tool.sh
build_image app_common latest src/app-demo.Dockerfile
✍️ Coding Guidelines
When developing in this project, variables should place their type or primary characteristics/role prefix first:
- Correct:
name_service,port_service,svc_ingress,cfg_postgres. - Incorrect:
service_name,service_port,ingress_service,postgres_config.
For details on local setups, CI/CD specifications, and sub-module APIs, inspect our agent instruction files:
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aloha-2026.912.1257.tar.gz.
File metadata
- Download URL: aloha-2026.912.1257.tar.gz
- Upload date:
- Size: 54.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
36782e567cadbf9e7981c9e90942bb84d2f271210d007f3a1343201090ab6d06
|
|
| MD5 |
9e785e7bbe35b41eaed1046f5055f48d
|
|
| BLAKE2b-256 |
7e8f7460ed51220d58b5cbec5b53e3b68cb9c5afe7cedd434d13360ac5b953eb
|
File details
Details for the file aloha-2026.912.1257-py3-none-any.whl.
File metadata
- Download URL: aloha-2026.912.1257-py3-none-any.whl
- Upload date:
- Size: 80.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cea925161bdd881bfe4a1509965fbb1602f7e2338bbc5e2feea9edffaf132713
|
|
| MD5 |
c6109ec5920ba82d67ea5b76255b95d2
|
|
| BLAKE2b-256 |
3aabc8d19101da4ff59e33904848e92f8bbad5a5fc046850bd34122d45b088b3
|
