HAPE Framework
Table of Contents
- HAPE Solutions
- Intellectual Property / Permissions
- Contributions
- Demos
- Architecture
- Makefile
- Documentation
- API
- Getting started
- Author
HAPE Solutions
- HAPE Solutions is the official website for the HAPE company and product ecosystem.
- HAPE Vibes is the product for end-to-end service creation and deployment with integrated logging, monitoring, testing, planning, and architecture diagram workflows to help software architects and engineering teams deliver reliably and fast.
Intellectual Property / Permissions
Copyright (c) 2026 Hazem Ataya. All rights reserved.
This repository is not licensed. No permission is granted to use, copy, modify, merge, publish, distribute, sublicense, or sell any part of this repository or its contents without explicit written permission from the copyright holder.
Contributions
Contributions are not accepted at the moment.
Demos
DORA GitHub Project Dashboard
EKS Deployment Cost Dashboard
Architecture
graph TD
U[User]
G[Visualization Tool]
AG[DevOps Platform Agent]
subgraph APP["Application Layer"]
CLI[CLI]
API[API]
end
subgraph BL["Business Logic Layer"]
SVC[Services]
EXP[Metrics Collectors]
end
subgraph INT["Integration Layer"]
CP[Clients]
K[Kubernetes]
CLOUD[AWS GCP]
VCS[GitHub GitLab]
WM[Jira Confluence]
TF[Terraform State]
end
subgraph DATA["Data Layer"]
P[TSDB Time Series Database]
end
U --> CLI
U --> API
G --> U
AG --> CLI
AG --> API
CLI --> SVC
API --> SVC
SVC --> CP
EXP --> CP
P --> EXP
P --> G
P --> AG
CP --> K
CP --> CLOUD
CP --> VCS
CP --> WM
CP --> TF
Makefile
- Makefile Documentation - reference for Makefile variables, targets, and common workflows.
To list all available Make commands and their descriptions:
make help
Documentation
API
Docker
HAPE Framework is available as a Docker image on Docker Hub:
Getting started
Install HAPE with pip:
python3 -m pip install hape
Show available commands:
hape --help
Run FastAPI interface:
make run-api
HAPE supports both CLI and API workflows.
API endpoints mirror CLI commands with strict 1:1 naming parity.
Example: hape github init-repo maps to POST /github/init-repo.
API endpoints require bearer token auth. Token management uses admin key-protected endpoints.
Generate API token:
curl -s -X POST "http://localhost:8080/auth/tokens" \
-H "Content-Type: application/json" \
-H "X-Hape-Admin-Key: <YOUR_ADMIN_KEY>" \
-d '{"name":"automation-bot"}'
Use API token:
curl -s -X POST "http://localhost:8080/github/init-repo" \
-H "Authorization: Bearer <API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{"repo_path":"/path/to/repo","owner":"hape-vibes"}'
See docs/api/auth-and-tokens.md for token lifecycle and security guidance.
Expected output:
usage: hape [-h] [command] ...
CLI for platform and DevOps automations.
commands:
config config file operations.
gitlab GitLab operations.
github GitHub operations.
jira fetch Jira issue data, remote links, or add comments.
confluence confluence page operations.
csv csv conversion operations.
dora DORA metrics operations.
eks-deployment-cost generate EKS Deployment/StatefulSet cost report.
kube-agent investigate Kubernetes incidents from CLI triggers.
init-cicd scaffold deployment and CI files for supported projects.
markdown markdown table import/export operations.
options:
-h, --help show this help message and exit
--version print the installed hape version and exit.
--config-file-path CONFIG_FILE_PATH
path to config.json (default: ~/.hape/config.json).
Author
1 maintainer
Metadata
1 maintainer
Release files for hape 1.2.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hape-1.2.5.tar.gz | 119.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hape-1.2.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 303.1 kB
Release files / hape-1.2.5.tar.gz
| Download URL | hape-1.2.5.tar.gz |
|---|---|
| Size | 119.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
62876db2288625df0802a7cfb9c512c749551936e7352b08e7bf78f06ecc4ad6
|
|
BLAKE2b-256 checksum How to use checksums |
2f6b86030e565f88f36ea1c21c8eadbbd1d034f99a0fd66eda34c90a281d1449
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.14.3
|
Release files / hape-1.2.5-py3-none-any.whl
| Download URL | hape-1.2.5-py3-none-any.whl |
|---|---|
| Size | 183.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8aa47822b5a8c838a0702c4e4fdd30ee18cb6498c74a41178fd656574e7fa5dd
|
|
BLAKE2b-256 checksum How to use checksums |
1986059424efb1746c15cd9c03b11627cd4de87877a0c6b0f3472725b9de8055
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.14.3
|
