Skip to main content

django_octo_aurora

License: MIT Python Framework: Django Package Manager: Rye PyPI Version Latest on Django Packages Tests: pytest BDD: Behave Load Test: Locust CI Code Style: PEP 8 PyPI Provenance Snyk Vulnerabilities Security Audit OpenSSF Scorecard Socket Badge codecov

django_octo_aurora is a decoupled runtime software topology visualizer and interactive architecture showcase module under the Django-Octo ecosystem.

It inspects the host Django project structure, installed apps, AST metrics, and local Git commit history in real time, persisting lightweight snapshots for single-query rendering across both a public showcase endpoint and the Django Admin interface.


Core Architecture

  • Dual-Channel Access: Exposes an interactive HTML5 Canvas topology view on a dedicated route (/aurora/) and embeds the same preview directly inside the Django Admin (Aurora Snapshots).
  • Runtime Introspection: Scans active project directories (pathlib), extracts Python class/function counts (ast), detects coupled INSTALLED_APPS, and parses local Git history (git log) using only the Python standard library.
  • Single-Query Persistence: Stores serialized topology payloads in AuroraSnapshot, ensuring subsequent page loads execute in a single ORM query.
  • Interactive Canvas Controls: Supports directional navigation (keyboard arrows / WASD and on-screen D-Pad), module filtering checklists, file-type counters, commit timeline playback, presentation mode (H), and clean PNG export.

Installation & Quick Start

1. Install Package

pip install django-octo-aurora

Or using Rye:

rye add django-octo-aurora

2. Register App & Migrate

Add "django_octo_aurora" to INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    # ...
    "django_octo_aurora",
]

Run migrations:

python3 manage.py migrate

3. Mount Routes

Include the module URLs in your project's urls.py:

from django.contrib import admin
from django.urls import include, path

urlpatterns = [
    path("admin/", admin.site.urls),
    path("aurora/", include("django_octo_aurora.urls")),
]

Start the server (python3 manage.py runserver) and open http://127.0.0.1:8000 or http://127.0.0.1:8000/admin/django_octo_aurora/aurorasnapshot/.


Local Development (Rye)

git clone https://github.com/jeanpmodev/django_octo_aurora.git
cd django_octo_aurora
rye sync
rye run pytest
rye run behave

See TESTING.md for full QA and load testing instructions.


License

Distributed under the MIT License. See LICENSE for details.

Metadata

Release files for django-octo-aurora 0.1.1

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

Source distribution (sdist)

Source distribution for django-octo-aurora 0.1.1
File Size Uploaded Provenance Actions
django_octo_aurora-0.1.1.tar.gz 328.6 kB With provenance Details for django_octo_aurora-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for django-octo-aurora 0.1.1
File Interpreter ABI Platform Actions
django_octo_aurora-0.1.1-py3-none-any.whl Python 3 none any Details for django_octo_aurora-0.1.1-py3-none-any.whl

Total release size: 344.0 kB

Release files / django_octo_aurora-0.1.1.tar.gz

Download URL django_octo_aurora-0.1.1.tar.gz
Size 328.6 kB
Tags Source
SHA-256 checksum
How to use checksums
637e08c780afb059717820e1b814f956f9ba4686cd72e42173630e08f68aeb2d
BLAKE2b-256 checksum
How to use checksums
308786e74598e3231abe8016438fd24dd230843d6c15375131100310e38da054
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Release files / django_octo_aurora-0.1.1-py3-none-any.whl

Download URL django_octo_aurora-0.1.1-py3-none-any.whl
Size 15.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5ebb8b597ac55ac92a75dd8c267e4b225c4c0fb8802db061b8f4f50fc7b68ca4
BLAKE2b-256 checksum
How to use checksums
e473111e9e74e26305d66e2a21a77cc4c869033a0b7a1abde5a219bfcb4caaee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

Security for django-octo-aurora 0.1.1

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for django_octo_aurora-0.1.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 16, 2026.

Transparency log

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

0.1.1 This release

2 release files Full 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