animora 0.1.0__tar.gz

animora-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,81 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint-and-typecheck:
+    name: Lint & Type Check (Python 3.10)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install system dependencies (Linux)
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y ffmpeg libcairo2-dev libpango1.0-dev pkg-config
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run Ruff Linting
+        run: ruff check .
+
+      - name: Run Ruff Format Check
+        run: ruff format --check .
+
+      - name: Run MyPy Type Check
+        run: mypy src/ tests/
+
+  test-matrix:
+    name: Test (Python ${{ matrix.python-version }} on ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install system dependencies (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y ffmpeg libcairo2-dev libpango1.0-dev pkg-config
+
+      - name: Install system dependencies (macOS)
+        if: runner.os == 'macOS'
+        run: |
+          brew install ffmpeg cairo pango pkg-config
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run pytest
+        run: pytest

animora-0.1.0/.github/workflows/docs-deploy.yml

@@ -0,0 +1,30 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install documentation dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs-material
+
+      - name: Deploy MkDocs to GitHub Pages
+        run: mkdocs gh-deploy --force

animora-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  pypi-publish:
+    name: Build and publish Python 🐍 distribution 📦 to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build binary wheel and source tarball
+        run: python -m build
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true

animora-0.1.0/.gitignore

@@ -0,0 +1,51 @@
+# Animora Prompts (Internal)
+animora-prompts/
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual Environments
+.venv/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Testing & Quality Tooling
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# IDE / Editor
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db

animora-0.1.0/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to the **Animora** project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [0.1.0] - 2026-08-26
+
+### Added
+- **Core Architecture & Abstractions**:
+  - `Component` base class encapsulating visual state, geometric bounds, positioning fluent API, and the `.manim_object` escape hatch.
+  - `Scene` high-level declarative wrapper around Manim's Scene supporting polymorphic `.play()`.
+  - `Animation` polymorphic bridge wrapping Manim animations.
+  - `ComponentConfig` and `BoundingBox` geometry contracts.
+- **Visual Primitives (`animora.components`)**:
+  - `Text`: Typography component with font styling and text transformation animations (`animate_transform_text`).
+  - `Shape`: Versatile geometric primitive (`circle`, `rectangle`, `rounded_rectangle`, `polygon`).
+  - `Connector` & `Arrow`: Straight/curved connectors and directional arrows.
+  - `Group`: Composite multi-element container with `arrange(layout)`.
+  - `Panel`: Padded container card with header titles.
+  - `Label`: Text label primitive.
+- **Decoupled Layout Engines (`animora.layout`)**:
+  - `HorizontalLayout`, `VerticalLayout`, `GridLayout`, `CircularLayout`, `TreeLayout`, `GraphLayout` (NetworkX-powered), and `FlowLayout`.
+- **Design Tokens & Theme System (`animora.theme`)**:
+  - `ColorPalette`, `Typography`, `SpacingScale`, `StrokeScale`, `CornerRadius`, `AnimationTiming`.
+  - Built-in Themes: `ModernDark` (default), `PaperLight`, `Cyberpunk`, and `Monokai`.
+  - `use_theme()` context manager for block-level theme scoping.
+- **Data Visualization (`animora.dataviz`)**:
+  - `Axes`: 2D coordinate system with `c2p()` and `p2c()` mapping.
+  - `BarChart`: Proportional bar height scaling with `animate_grow()` and `animate_highlight_bar()`.
+  - `LineChart`: Progressive path drawing with `animate_draw()`.
+  - `ScatterPlot`: 2D point cloud with `animate_plot()`.
+  - `Histogram`: Statistical frequency distribution verified against `numpy.histogram`.
+  - `Table`: Tabular matrix visualizer with `animate_highlight_cell()`.
+- **Computer Science Data Structures (`animora.datastructures`)**:
+  - Independent pure Python models (`XModel`) paired with animation layers (`X`).
+  - `Array`, `Stack`, `Queue`, `LinkedList`, `Heap`, `Tree`, `BST`, `Graph`, and `HashTable` (Separate Chaining).
+  - Path-traced operations and complete 3-case BST deletion (leaf, 1-child, 2-children).
+- **Algorithm Visualizations (`animora.algorithms`)**:
+  - `OperationTrace` event recording framework.
+  - `binary_search` with interval comparison tracing.
+  - 5 visually distinguishable sorting algorithms: `bubble_sort`, `selection_sort`, `insertion_sort`, `merge_sort`, `quick_sort`.
+  - Graph traversals: `bfs` and `dfs`.
+  - Pathfinding: `dijkstra` and `a_star` with distinct exploration patterns.
+  - Dynamic Programming: `fibonacci_dp` on `Table`.
+  - Backtracking: `n_queens` with conflict backtracking.
+- **Developer CLI (`animora.cli`)**:
+  - `animora new`: Scaffold starter scene from template.
+  - `animora preview`: Fast low-quality preview (`-ql`).
+  - `animora render`: Production quality render (`-qh`, `-qk`).
+  - `animora doctor`: System and environment diagnostics.
+- **Documentation & Examples**:
+  - MkDocs Material documentation site with Getting Started tutorials, subsystem guides, API reference, recipes, and troubleshooting.
+  - Seven runnable, tested example scenes in `examples/`.
+- **Benchmarking & Performance**:
+  - Benchmark suite measuring construction, layout, and trace generation.
+  - Bounding box memoization in `Component`.

animora-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,54 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1.

animora-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,79 @@
+# Contributing to Animora
+
+Thank you for your interest in contributing to **Animora**! We welcome contributions to help make educational animation intuitive and accessible.
+
+---
+
+## 🛠️ Development Setup
+
+Animora requires **Python 3.10+**. We recommend using a virtual environment.
+
+### 1. Clone the repository
+```bash
+git clone https://github.com/himanshu-jadhav108/Animora.git
+cd Animora
+```
+
+### 2. Create and activate a virtual environment
+```bash
+python -m venv .venv
+
+# On Linux/macOS:
+source .venv/bin/activate
+
+# On Windows:
+.venv\Scripts\activate
+```
+
+### 3. Install in editable mode with development dependencies
+```bash
+pip install -e ".[dev]"
+```
+
+---
+
+## 🧪 Quality Checks & Validation
+
+Before submitting a Pull Request, make sure all quality checks pass locally:
+
+### Run Linter and Formatter
+```bash
+ruff check .
+ruff format --check .
+```
+To auto-fix linting and formatting issues:
+```bash
+ruff check --fix .
+ruff format .
+```
+
+### Run Type Checking
+```bash
+mypy src/ tests/
+```
+
+### Run Tests
+```bash
+pytest
+```
+
+### Build Documentation
+```bash
+mkdocs build
+```
+
+---
+
+## 📐 Architecture Guidelines
+
+All contributions must follow the architectural boundaries established in `docs/architecture/`:
+1. **Separation of Concerns**: Layout algorithms belong in `animora.layout`, not inside component classes.
+2. **First-Class Escape Hatch**: Every component must expose `.manim_object`.
+3. **Type Safety**: All public functions and classes must be 100% type-annotated.
+4. **Public API Exports**: Export public symbols explicitly in `__all__`.
+
+---
+
+## 📜 Code of Conduct
+
+Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) in all community interactions.

animora-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Himanshu Jadhav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.