surrealdb-orm 0.1.4__tar.gz → 0.5.1__tar.gz

{surrealdb_orm-0.1.4 → surrealdb_orm-0.5.1}/.gitignore

@@ -75,4 +75,7 @@ external_pkg_ref/
 .mypy_cache/
 .ruff_cache/
 .dmypy.json
-dmypy.json
+dmypy.json
+
+# Claude
+.claude/

{surrealdb_orm-0.1.4 → surrealdb_orm-0.5.1}/LICENSE

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2024 Yannick Croteau
+Copyright (c) 2025-2026 Yannick Croteau
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

surrealdb_orm-0.5.1/Makefile

@@ -0,0 +1,200 @@
+.DEFAULT_GOAL := all
+sources = src
+COMPOSE_FILE = devops/docker-compose.yml
+
+.PHONY: .uv  # Check that uv is installed
+.uv:
+	@uv --version || echo 'Please install uv: https://docs.astral.sh/uv/getting-started/installation/'
+
+.PHONY: install  # Install the package, dependencies, and pre-commit for local development
+install: .uv
+	uv sync --frozen --group lint
+	uv run pre-commit install --install-hooks
+
+.PHONY: format  # Format the code
+format:
+	uv run ruff format
+	uv run ruff check --fix --fix-only
+
+.PHONY: lint  # Lint the code
+lint:
+	uv run ruff format --check
+	uv run ruff check
+
+.PHONY: mypy
+mypy:
+	uv run python -m mypy $(sources)
+
+.PHONY: typecheck
+typecheck:
+	uv run pyright
+
+.PHONY: test
+test:
+	uv run pytest -m "not integration"
+
+.PHONY: test-unit  # Run unit tests only (no SurrealDB required)
+test-unit:
+	uv run pytest -m "not integration" tests/
+
+.PHONY: test-sdk  # Run SDK tests only
+test-sdk:
+	uv run pytest -m "not integration" tests/sdk/
+
+.PHONY: test-integration  # Run integration tests (requires SurrealDB)
+test-integration: db-up
+	uv run pytest -m integration tests/
+
+.PHONY: test-all  # Run all tests including integration
+test-all: db-up
+	uv run pytest tests/
+
+.PHONY: test-all-python  # Run tests on Python 3.12 to 3.14
+test-all-python:
+	uv run --python 3.12 coverage run -p -m pytest -m "not integration" --junitxml=junit.xml -o junit_family=legacy
+	UV_PROJECT_ENVIRONMENT=.venv313 uv run --python 3.13 coverage run -p -m pytest -m "not integration"
+	UV_PROJECT_ENVIRONMENT=.venv314 uv run --python 3.14 coverage run -p -m pytest -m "not integration"
+	@uv run coverage xml -o coverage.xml
+	@uv run coverage report
+
+.PHONY: html  # Generate HTML coverage report
+html: test-all-python
+	uv run coverage html -d htmlcov
+
+# =============================================================================
+# Docker commands for SurrealDB
+# =============================================================================
+
+.PHONY: db-up  # Start SurrealDB container for testing
+db-up:
+	docker compose -f $(COMPOSE_FILE) up -d surrealdb-test
+	@./devops/wait-for-healthy.sh localhost 8001 30
+	@echo "SurrealDB test instance ready on port 8001"
+
+.PHONY: db-down  # Stop SurrealDB containers
+db-down:
+	docker compose -f $(COMPOSE_FILE) down
+
+.PHONY: db-dev  # Start development SurrealDB (persistent)
+db-dev:
+	docker compose -f $(COMPOSE_FILE) up -d surrealdb
+	@./devops/wait-for-healthy.sh localhost 8000 30
+	@echo "SurrealDB dev instance ready on port 8000 (persistent)"
+
+.PHONY: db-cluster  # Start multi-node cluster for K8s simulation
+db-cluster:
+	docker compose -f $(COMPOSE_FILE) --profile cluster up -d
+	@./devops/wait-for-healthy.sh localhost 8002 30
+	@./devops/wait-for-healthy.sh localhost 8003 30
+	@./devops/wait-for-healthy.sh localhost 8004 30
+	@echo "SurrealDB cluster ready on ports 8002, 8003, 8004"
+
+.PHONY: db-logs  # Show SurrealDB logs
+db-logs:
+	docker compose -f $(COMPOSE_FILE) logs -f surrealdb-test
+
+.PHONY: db-logs-dev  # Show dev SurrealDB logs
+db-logs-dev:
+	docker compose -f $(COMPOSE_FILE) logs -f surrealdb
+
+.PHONY: db-shell  # Open SurrealDB SQL shell (test instance)
+db-shell:
+	docker compose -f $(COMPOSE_FILE) exec surrealdb-test /surreal sql --endpoint http://localhost:8000 --username root --password root --namespace test --database test
+
+.PHONY: db-shell-dev  # Open SurrealDB SQL shell (dev instance)
+db-shell-dev:
+	docker compose -f $(COMPOSE_FILE) exec surrealdb /surreal sql --endpoint http://localhost:8000 --username root --password root --namespace test --database test
+
+.PHONY: db-setup  # Setup test database schema
+db-setup: db-up
+	@./devops/setup-test-db.sh localhost 8001
+
+.PHONY: db-status  # Show status of all SurrealDB containers
+db-status:
+	@docker compose -f $(COMPOSE_FILE) ps
+
+.PHONY: db-clean  # Remove all SurrealDB containers and volumes
+db-clean:
+	docker compose -f $(COMPOSE_FILE) down -v --remove-orphans
+
+# =============================================================================
+# CI targets
+# =============================================================================
+
+.PHONY: ci-db-up  # Start SurrealDB for CI (optimized)
+ci-db-up:
+	docker compose -f $(COMPOSE_FILE) up -d surrealdb-ci
+	@./devops/wait-for-healthy.sh localhost 8000 60
+	@echo "SurrealDB CI instance ready"
+
+.PHONY: ci-test  # Run all tests for CI
+ci-test: ci-db-up
+	uv run pytest tests/ --junitxml=junit.xml -o junit_family=legacy
+	uv run coverage xml -o coverage.xml
+
+.PHONY: ci-lint  # Run linting for CI
+ci-lint:
+	uv run ruff format --check
+	uv run ruff check
+	uv run python -m mypy $(sources)
+
+.PHONY: ci  # Full CI pipeline
+ci: ci-lint ci-test
+
+# =============================================================================
+# Utilities
+# =============================================================================
+
+.PHONY: clean  # Clean up generated files
+clean:
+	rm -rf .pytest_cache .mypy_cache .ruff_cache htmlcov .coverage coverage.xml junit.xml
+	rm -rf dist build *.egg-info
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+
+.PHONY: clean-all  # Clean everything including Docker
+clean-all: clean db-clean
+
+.PHONY: all
+all: format mypy lint typecheck test-all-python
+
+.PHONY: help  # Show this help
+help:
+	@echo "Available targets:"
+	@echo ""
+	@echo "  Development:"
+	@echo "    install          Install dependencies and pre-commit hooks"
+	@echo "    format           Format code with ruff"
+	@echo "    lint             Check code with ruff"
+	@echo "    mypy             Run mypy type checker"
+	@echo "    typecheck        Run pyright type checker"
+	@echo ""
+	@echo "  Testing:"
+	@echo "    test             Run unit tests (no SurrealDB required)"
+	@echo "    test-unit        Run unit tests only"
+	@echo "    test-sdk         Run SDK tests only"
+	@echo "    test-integration Run integration tests (starts SurrealDB)"
+	@echo "    test-all         Run all tests including integration"
+	@echo "    test-all-python  Run tests on Python 3.12-3.14"
+	@echo ""
+	@echo "  Docker/SurrealDB:"
+	@echo "    db-up            Start test SurrealDB (port 8001)"
+	@echo "    db-dev           Start dev SurrealDB (port 8000, persistent)"
+	@echo "    db-cluster       Start 3-node cluster (ports 8002-8004)"
+	@echo "    db-down          Stop all SurrealDB containers"
+	@echo "    db-logs          Show test SurrealDB logs"
+	@echo "    db-shell         Open test SurrealDB SQL shell"
+	@echo "    db-setup         Setup test database schema"
+	@echo "    db-status        Show container status"
+	@echo "    db-clean         Remove containers and volumes"
+	@echo ""
+	@echo "  CI:"
+	@echo "    ci               Full CI pipeline (lint + test)"
+	@echo "    ci-db-up         Start SurrealDB for CI"
+	@echo "    ci-test          Run tests for CI"
+	@echo "    ci-lint          Run linting for CI"
+	@echo ""
+	@echo "  Other:"
+	@echo "    clean            Clean generated files"
+	@echo "    clean-all        Clean everything including Docker"
+	@echo "    all              Run format, lint, typecheck, and tests"
+	@echo "    help             Show this help"

surrealdb_orm-0.5.1/PKG-INFO

@@ -0,0 +1,465 @@
+Metadata-Version: 2.4
+Name: surrealdb-orm
+Version: 0.5.1
+Summary: SurrealDB ORM as 'DJango style' for Python with async support. Works with pydantic validation.
+Project-URL: Homepage, https://github.com/EulogySnowfall/SurrealDB-ORM
+Project-URL: Documentation, https://github.com/EulogySnowfall/SurrealDB-ORM
+Project-URL: Repository, https://github.com/EulogySnowfall/SurrealDB-ORM.git
+Project-URL: Issues, https://github.com/EulogySnowfall/SurrealDB-ORM/issues
+Author-email: Yannick Croteau <croteau.yannick@gmail.com>
+License: # MIT License
+        
+        Copyright (c) 2025-2026 Yannick Croteau
+        
+        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.
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.10.5
+Provides-Extra: all
+Requires-Dist: cbor2>=5.6.0; extra == 'all'
+Requires-Dist: click>=8.1.0; extra == 'all'
+Provides-Extra: cbor
+Requires-Dist: cbor2>=5.6.0; extra == 'cbor'
+Provides-Extra: cli
+Requires-Dist: click>=8.1.0; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# SurrealDB-ORM
+
+![Python](https://img.shields.io/badge/python-3.12%2B-blue)
+![CI](https://github.com/EulogySnowfall/SurrealDB-ORM/actions/workflows/ci.yml/badge.svg)
+[![codecov](https://codecov.io/gh/EulogySnowfall/SurrealDB-ORM/graph/badge.svg?token=XUONTG2M6Z)](https://codecov.io/gh/EulogySnowfall/SurrealDB-ORM)
+![GitHub License](https://img.shields.io/github/license/EulogySnowfall/SurrealDB-ORM)
+
+> **Alpha Software** - APIs may change. Use in non-production environments.
+
+**SurrealDB-ORM** is a Django-style ORM for [SurrealDB](https://surrealdb.com/) with async support, Pydantic validation, and JWT authentication.
+
+**Includes a custom SDK (`surreal_sdk`)** - Zero dependency on the official `surrealdb` package!
+
+---
+
+## What's New in 0.4.0
+
+- **Relations & Graph Traversal** - Django-style relation definitions with SurrealDB graph support
+  - `ForeignKey`, `ManyToMany`, `Relation` field types
+  - Relation operations: `add()`, `remove()`, `set()`, `clear()`, `all()`, `filter()`, `count()`
+  - Model methods: `relate()`, `remove_relation()`, `get_related()`
+  - QuerySet extensions: `select_related()`, `prefetch_related()`, `traverse()`, `graph_query()`
+
+---
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+  - [Using the SDK (Recommended)](#using-the-sdk-recommended)
+  - [Using the ORM](#using-the-orm)
+- [SDK Features](#sdk-features)
+  - [Connections](#connections)
+  - [Transactions](#transactions)
+  - [Typed Functions](#typed-functions)
+  - [Live Queries](#live-queries)
+- [ORM Features](#orm-features)
+- [CLI Commands](#cli-commands)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+
+---
+
+## Installation
+
+```bash
+# Basic installation
+pip install surrealdb-orm
+
+# With CLI support
+pip install surrealdb-orm[cli]
+
+# Full installation (CLI + CBOR)
+pip install surrealdb-orm[all]
+```
+
+**Requirements:** Python 3.12+ | SurrealDB 2.6.0+
+
+---
+
+## Quick Start
+
+### Using the SDK (Recommended)
+
+```python
+from surreal_sdk import SurrealDB
+
+async def main():
+    # HTTP connection (stateless, ideal for microservices)
+    async with SurrealDB.http("http://localhost:8000", "namespace", "database") as db:
+        await db.signin("root", "root")
+
+        # CRUD operations
+        user = await db.create("users", {"name": "Alice", "age": 30})
+        users = await db.query("SELECT * FROM users WHERE age > $min", {"min": 18})
+
+        # Atomic transactions
+        async with db.transaction() as tx:
+            await tx.create("accounts:alice", {"balance": 1000})
+            await tx.create("accounts:bob", {"balance": 500})
+            # Auto-commit on success, auto-rollback on exception
+
+        # Built-in functions with typed API
+        result = await db.fn.math.sqrt(16)  # Returns 4.0
+        now = await db.fn.time.now()        # Current timestamp
+```
+
+### Using the ORM
+
+```python
+from surreal_orm import BaseSurrealModel, SurrealDBConnectionManager
+
+# 1. Define your model
+class User(BaseSurrealModel):
+    id: str | None = None
+    name: str
+    email: str
+    age: int = 0
+
+# 2. Configure connection
+SurrealDBConnectionManager.set_connection(
+    url="http://localhost:8000",
+    user="root",
+    password="root",
+    namespace="myapp",
+    database="main",
+)
+
+# 3. CRUD operations
+user = User(name="Alice", email="alice@example.com", age=30)
+await user.save()
+
+users = await User.objects().filter(age__gte=18).order_by("name").limit(10).exec()
+```
+
+---
+
+## SDK Features
+
+### Connections
+
+| Type          | Use Case                 | Features                 |
+| ------------- | ------------------------ | ------------------------ |
+| **HTTP**      | Microservices, REST APIs | Stateless, simple        |
+| **WebSocket** | Real-time apps           | Live queries, persistent |
+| **Pool**      | High-throughput          | Connection reuse         |
+
+```python
+from surreal_sdk import SurrealDB, HTTPConnection, WebSocketConnection
+
+# HTTP (stateless)
+async with SurrealDB.http("http://localhost:8000", "ns", "db") as db:
+    await db.signin("root", "root")
+
+# WebSocket (stateful, real-time)
+async with SurrealDB.ws("ws://localhost:8000", "ns", "db") as db:
+    await db.signin("root", "root")
+    await db.live("orders", callback=on_order_change)
+
+# Connection Pool
+async with SurrealDB.pool("http://localhost:8000", "ns", "db", size=10) as pool:
+    await pool.set_credentials("root", "root")
+    async with pool.acquire() as conn:
+        await conn.query("SELECT * FROM users")
+```
+
+### Transactions
+
+Atomic transactions with automatic commit/rollback:
+
+```python
+# WebSocket: Immediate execution with server-side transaction
+async with db.transaction() as tx:
+    await tx.update("players:abc", {"is_ready": True})
+    await tx.update("game_tables:xyz", {"ready_count": "+=1"})
+    # Statements execute immediately
+    # COMMIT on success, CANCEL on exception
+
+# HTTP: Batched execution (all-or-nothing)
+async with db.transaction() as tx:
+    await tx.create("orders:1", {"total": 100})
+    await tx.create("payments:1", {"amount": 100})
+    # Statements queued, executed atomically at commit
+```
+
+**Transaction Methods:**
+
+- `tx.query(sql, vars)` - Execute raw SurrealQL
+- `tx.create(thing, data)` - Create record
+- `tx.update(thing, data)` - Replace record
+- `tx.delete(thing)` - Delete record
+- `tx.relate(from, edge, to)` - Create graph edge
+- `tx.commit()` - Explicit commit
+- `tx.rollback()` - Explicit rollback
+
+### Typed Functions
+
+Fluent API for SurrealDB functions:
+
+```python
+# Built-in functions (namespace::function)
+sqrt = await db.fn.math.sqrt(16)           # 4.0
+now = await db.fn.time.now()               # datetime
+length = await db.fn.string.len("hello")   # 5
+sha = await db.fn.crypto.sha256("data")    # hash string
+
+# Custom user-defined functions (fn::function)
+result = await db.fn.my_custom_function(arg1, arg2)
+# Executes: RETURN fn::my_custom_function($arg0, $arg1)
+```
+
+**Available Namespaces:**
+`array`, `crypto`, `duration`, `geo`, `http`, `math`, `meta`, `object`, `parse`, `rand`, `session`, `string`, `time`, `type`, `vector`
+
+### Live Queries
+
+Real-time updates via WebSocket:
+
+```python
+from surreal_sdk import LiveQuery, LiveNotification, LiveAction
+
+async def on_change(notification: LiveNotification):
+    if notification.action == LiveAction.CREATE:
+        print(f"New record: {notification.result}")
+    elif notification.action == LiveAction.UPDATE:
+        print(f"Updated: {notification.result}")
+    elif notification.action == LiveAction.DELETE:
+        print(f"Deleted: {notification.result}")
+
+live = LiveQuery(ws_conn, "orders")
+await live.subscribe(on_change)
+# ... records changes trigger callbacks ...
+await live.unsubscribe()
+```
+
+---
+
+## ORM Features
+
+### QuerySet with Django-style Lookups
+
+```python
+# Filter with lookups
+users = await User.objects().filter(age__gte=18, name__startswith="A").exec()
+
+# Supported lookups
+# exact, gt, gte, lt, lte, in, like, ilike, contains, icontains,
+# startswith, istartswith, endswith, iendswith, match, regex, isnull
+```
+
+### ORM Transactions
+
+```python
+from surreal_orm import SurrealDBConnectionManager
+
+# Via ConnectionManager
+async with SurrealDBConnectionManager.transaction() as tx:
+    user = User(name="Alice", balance=1000)
+    await user.save(tx=tx)
+
+    order = Order(user_id=user.id, total=100)
+    await order.save(tx=tx)
+    # Auto-commit on success, auto-rollback on exception
+
+# Via Model class method
+async with User.transaction() as tx:
+    await user1.save(tx=tx)
+    await user2.delete(tx=tx)
+```
+
+### Aggregations
+
+```python
+# Simple aggregations
+total = await User.objects().count()
+total = await User.objects().filter(active=True).count()
+
+# Field aggregations
+avg_age = await User.objects().avg("age")
+total = await Order.objects().filter(status="paid").sum("amount")
+min_val = await Product.objects().min("price")
+max_val = await Product.objects().max("price")
+```
+
+### GROUP BY with Aggregations
+
+```python
+from surreal_orm import Count, Sum, Avg
+
+# Group by single field
+stats = await Order.objects().values("status").annotate(
+    count=Count(),
+    total=Sum("amount"),
+).exec()
+# Result: [{"status": "paid", "count": 42, "total": 5000}, ...]
+
+# Group by multiple fields
+monthly = await Order.objects().values("status", "month").annotate(
+    count=Count(),
+).exec()
+```
+
+### Bulk Operations
+
+```python
+# Bulk create
+users = [User(name=f"User{i}") for i in range(100)]
+created = await User.objects().bulk_create(users)
+
+# Atomic bulk create (all-or-nothing)
+created = await User.objects().bulk_create(users, atomic=True)
+
+# Bulk update
+updated = await User.objects().filter(status="pending").bulk_update(
+    {"status": "active"}
+)
+
+# Bulk delete
+deleted = await User.objects().filter(status="deleted").bulk_delete()
+```
+
+### Table Types
+
+| Type     | Description                 |
+| -------- | --------------------------- |
+| `NORMAL` | Standard table (default)    |
+| `USER`   | Auth table with JWT support |
+| `STREAM` | Real-time with CHANGEFEED   |
+| `HASH`   | Lookup/cache (SCHEMALESS)   |
+
+```python
+from surreal_orm import BaseSurrealModel, SurrealConfigDict
+from surreal_orm.types import TableType
+
+class User(BaseSurrealModel):
+    model_config = SurrealConfigDict(
+        table_type=TableType.USER,
+        permissions={"select": "$auth.id = id"},
+    )
+```
+
+### JWT Authentication
+
+```python
+from surreal_orm.auth import AuthenticatedUserMixin
+from surreal_orm.fields import Encrypted
+
+class User(AuthenticatedUserMixin, BaseSurrealModel):
+    model_config = SurrealConfigDict(table_type=TableType.USER)
+    email: str
+    password: Encrypted  # Auto-hashed with argon2
+    name: str
+
+# Signup
+user = await User.signup(email="alice@example.com", password="secret", name="Alice")
+
+# Signin
+user, token = await User.signin(email="alice@example.com", password="secret")
+
+# Validate token
+user = await User.authenticate_token(token)
+```
+
+---
+
+## CLI Commands
+
+Requires `pip install surrealdb-orm[cli]`
+
+| Command             | Description                 |
+| ------------------- | --------------------------- |
+| `makemigrations`    | Generate migration files    |
+| `migrate`           | Apply schema migrations     |
+| `rollback <target>` | Rollback to migration       |
+| `status`            | Show migration status       |
+| `shell`             | Interactive SurrealQL shell |
+
+```bash
+# Generate and apply migrations
+surreal-orm makemigrations --name initial
+surreal-orm migrate -u http://localhost:8000 -n myns -d mydb
+
+# Environment variables supported
+export SURREAL_URL=http://localhost:8000
+export SURREAL_NAMESPACE=myns
+export SURREAL_DATABASE=mydb
+surreal-orm migrate
+```
+
+---
+
+## Documentation
+
+| Document                               | Description              |
+| -------------------------------------- | ------------------------ |
+| [SDK Guide](docs/sdk.md)               | Full SDK documentation   |
+| [Migration System](docs/migrations.md) | Django-style migrations  |
+| [Authentication](docs/auth.md)         | JWT authentication guide |
+| [Roadmap](docs/roadmap.md)             | Future features planning |
+| [CHANGELOG](CHANGELOG)                 | Version history          |
+
+---
+
+## Contributing
+
+```bash
+# Clone and install
+git clone https://github.com/EulogySnowfall/SurrealDB-ORM.git
+cd SurrealDB-ORM
+uv sync
+
+# Run tests (SurrealDB container managed automatically)
+make test              # Unit tests only
+make test-integration  # With integration tests
+
+# Start SurrealDB manually
+make db-up             # Test instance (port 8001)
+make db-dev            # Dev instance (port 8000)
+
+# Lint
+make ci-lint           # Run all linters
+```
+
+---
+
+## License
+
+MIT License - See [LICENSE](LICENSE) file.
+
+---
+
+**Author:** Yannick Croteau | **GitHub:** [EulogySnowfall](https://github.com/EulogySnowfall)