Metadata-Version: 2.4
Name: astronomer-orbis
Version: 0.9.1
Summary: A tool for generating astronomer software deployment compute reports
Project-URL: Homepage, https://github.com/astronomer/orbis
Project-URL: Bug Tracker, https://github.com/astronomer/orbis/issues
Author-email: Astronomer <humans@astronomer.io>, Abhishek Bhakat <abhishek.bhakat@astronomer.io>, Indraneel Dongaonkar <indraneel.dongaonkar@astronomer.io>, Sudarshan Chaudhari <sudarshan.chaudhari@astronomer.io>
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: click==8.2.1
Requires-Dist: jinja2==3.1.6
Requires-Dist: kaleido==1.0.0
Requires-Dist: kubernetes==33.1.0
Requires-Dist: pendulum==3.1.0
Requires-Dist: pillow==11.3.0
Requires-Dist: plotly==6.2.0
Requires-Dist: polars==1.31.0
Requires-Dist: python-docx==1.2.0
Requires-Dist: python-dotenv==1.1.1
Requires-Dist: pyyaml==6.0.2
Requires-Dist: requests==2.32.4
Provides-Extra: dev
Requires-Dist: hatch==1.14.1; extra == 'dev'
Requires-Dist: pre-commit==4.2.0; extra == 'dev'
Requires-Dist: pytest-asyncio==1.0.0; extra == 'dev'
Requires-Dist: pytest-cov==6.2.1; extra == 'dev'
Requires-Dist: pytest-mock==3.14.1; extra == 'dev'
Requires-Dist: pytest==8.4.1; extra == 'dev'
Requires-Dist: ruff==0.12.1; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-awesome-pages-plugin==2.9.3; extra == 'docs'
Requires-Dist: mkdocs-git-revision-date-localized-plugin==1.3.0; extra == 'docs'
Requires-Dist: mkdocs-glightbox==0.4.0; extra == 'docs'
Requires-Dist: mkdocs-macros-plugin==1.3.7; extra == 'docs'
Requires-Dist: mkdocs-material==9.6.15; extra == 'docs'
Requires-Dist: mkdocs-minify-plugin==0.8.0; extra == 'docs'
Requires-Dist: mkdocs-redirects==1.2.1; extra == 'docs'
Requires-Dist: mkdocs==1.6.1; extra == 'docs'
Requires-Dist: mkdocstrings-python==1.16.12; extra == 'docs'
Requires-Dist: mkdocstrings==0.29.1; extra == 'docs'
Description-Content-Type: text/markdown

# Orbis

Orbis is a diagnostic and reporting tool for Astro Private Cloud (formerly Astronomer Software). It collects support bundles from Kubernetes clusters and generates deployment compute reports.

## Key Features

1. **Report Generation** — Deployment metrics analysis including CPU usage, memory consumption, resource allocation, task success/failure rates, processing trends, and execution latency. Outputs DOCX, CSV, and JSON reports.
2. **Diagnostic Scanner** — Creates support bundles containing Kubernetes cluster information, Astronomer deployment details, logs, and configurations. Supports CP/DP multi-cluster collection, session management, and incremental resume workflows.

## Quick Start

### Report Generation

```bash
echo "ASTRO_SOFTWARE_API_TOKEN=<your-token>" > .env && mkdir -p output
podman run --rm -it \
  --env-file .env \
  -v $(pwd)/output:/app/output \
  quay.io/astronomer/orbis:0.9.0 \
  reporting \
  -s <start-date> \
  -e <end-date> \
  -b <base-domain>
```

Or install locally:

```bash
pip install astronomer-orbis
export ASTRO_SOFTWARE_API_TOKEN=<your-token>
orbis reporting -s <start-date> -e <end-date> -b <base-domain>
```

### Diagnostic Scanner

```bash
podman run --rm -it \
  -e ASTRO_SOFTWARE_API_TOKEN=<your-token> \
  -v <path-to-kubeconfig>:/tmp/kubeconfig:ro \
  -v $(pwd)/output:/app/output \
  quay.io/astronomer/orbis:0.9.0 \
  scanner create \
  -n <platform-namespace> \
  --kubeconfig /tmp/kubeconfig \
  --image quay.io/astronomer/orbis:0.9.0
```

## Installation

Install with `uv` (recommended for CLI tools):

```bash
uv tool install astronomer-orbis
```

Or with `pip`:

```bash
pip install astronomer-orbis
```

## Documentation

Full documentation is available at **https://astronomer.github.io/orbis-docs/**

- [Install Orbis](https://astronomer.github.io/orbis-docs/get-started/install/)
- [Generate a compute report](https://astronomer.github.io/orbis-docs/reporting/generate-report/)
- [Create a support bundle](https://astronomer.github.io/orbis-docs/scanner/create-support-bundle/)
- [Multi-cluster guide](https://astronomer.github.io/orbis-docs/scanner/multi-cluster-guide/)
- [Changelog](https://astronomer.github.io/orbis-docs/changelog/)

## License

Copyright (c) 2021 Astronomer, LLC
