Skip to main content

Agentic Updates, Reviews, and Accountability — CI-native weekly project briefs powered by Pydantic AI.

Project description

OpenAURA logo

PyPI Python CI CodeQL OpenSSF Scorecard Coverage License

OpenAURA is a CI-native Python CLI that generates recurring project briefs from delivery signals and writes markdown reports into aura-docs/.

This page is the technical package reference. The human/product README lives in the GitHub repository.

Requirements

  • Python 3.11 or newer
  • A model provider key for Anthropic or OpenAI
  • At least one signal connector, currently GitHub or Azure DevOps

The project CI verifies Python 3.11, 3.12, 3.13, and 3.14.

Installation

python -m pip install open-aura

The package installs the aura console command.

Configuration

Create aura.config.yml at the root of the repository where briefs should be written:

project: "my-project"
trigger: weekly
schedule: "friday-5pm"
model: "anthropic:claude-sonnet-4-6"

signals:
  github:
    repo: "owner/repository"
    token_env: GITHUB_TOKEN
    default_branch: main

kpis:
  - throughput
  - cycle_time
  - blockers
  - bug_count

custom_kpis: []

output:
  folder: "aura-docs"

Supported trigger values are:

  • weekly
  • on-merge
  • both

The schedule field is documentation for humans. The actual cron schedule belongs in your CI workflow.

Environment Variables

OpenAURA reads secret values from environment variables. The config file stores only the variable names.

Purpose Default variable
Anthropic models ANTHROPIC_API_KEY
OpenAI models OPENAI_API_KEY
GitHub connector GITHUB_TOKEN
Azure DevOps org AZURE_DEVOPS_ORG
Azure DevOps project AZURE_DEVOPS_PROJECT
Azure DevOps token AZURE_DEVOPS_TOKEN

Model strings beginning with anthropic: require ANTHROPIC_API_KEY. Model strings beginning with openai: require OPENAI_API_KEY.

CLI

aura validate
aura run
aura run --dry-run
aura run --trigger on-merge
aura manifesto

aura validate checks the config and required environment variables without making API or LLM calls.

aura run gathers signals, scores the project state, summarizes the brief, and writes markdown to the configured output folder.

aura run --dry-run prints the structured brief JSON instead of writing a file.

GitHub Actions

Install OpenAURA in a workflow with pip:

- uses: actions/setup-python@v6
  with:
    python-version: "3.13"

- run: python -m pip install open-aura
- run: aura validate
- run: aura run
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
    OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

The repository includes starter workflow templates for weekly, on-merge, and combined trigger modes.

Output

By default, briefs are written to:

aura-docs/

Each brief is markdown, intended to be committed back to the same repository by CI.

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

open_aura-0.1.2.tar.gz (47.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

open_aura-0.1.2-py3-none-any.whl (37.9 kB view details)

Uploaded Python 3

File details

Details for the file open_aura-0.1.2.tar.gz.

File metadata

  • Download URL: open_aura-0.1.2.tar.gz
  • Upload date:
  • Size: 47.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for open_aura-0.1.2.tar.gz
Algorithm Hash digest
SHA256 c77f0e0f6b788becb43d1f035977f91849d32b200a2fbd390f4d19cf9efe54a6
MD5 b3c7285b52876f9e9c4f4cd35c163a73
BLAKE2b-256 c9f4ad61119063828a8c383b2f6bb1393ac7ad9fb3c4f468500e2ec34e66d838

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_aura-0.1.2.tar.gz:

Publisher: release.yml on pradelgorithm/openaura

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file open_aura-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: open_aura-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 37.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for open_aura-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9270d63e941eb46d50b9a0342a3bd68b92a20d949f5c13e87b2138bbd9f684f8
MD5 ed732e16e0d043a2405264efd5787f80
BLAKE2b-256 121873228d8f93b33e83a896f11b6fee5a873816ddc0c3c5cd7ca25cb4a60a08

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_aura-0.1.2-py3-none-any.whl:

Publisher: release.yml on pradelgorithm/openaura

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page