revvlink 3.6.0__tar.gz

revvlink-3.6.0/.antigravity/rules.md

@@ -0,0 +1,259 @@
+# ReWaveLink Antigravity Rules
+
+> **Version:** 1.0.0  
+> **Last Updated:** March 8, 2026
+
+This file defines the development rules and pre-commit checks for the ReWaveLink project.
+
+---
+
+## 🎯 Overview
+
+ReWaveLink uses a multi-layered code quality system:
+
+1. **Pre-commit hooks** - Automated checks that run before each commit
+2. **Linting** - Code style and quality enforcement
+3. **Type checking** - Static type analysis
+4. **Testing** - Automated test suite
+
+---
+
+## ✅ Pre-commit Checks
+
+Before committing, ensure all checks pass:
+
+### 1. Ruff Linting (Required)
+```bash
+ruff check .
+```
+- Fixes automatically: `ruff check . --fix`
+- Strict configuration in `pyproject.toml`
+- Target: Python 3.10+
+
+### 2. Ruff Formatting (Required)
+```bash
+ruff format .
+```
+- Enforces Black-compatible formatting
+- Line length: 100 characters
+
+### 3. Pyright Type Checking (Required)
+```bash
+pyright rewavelink/
+```
+- Strict mode enabled
+- Python 3.10 type checking
+- Configured in `pyproject.toml`
+
+### 4. Test Suite (Required)
+```bash
+pytest tests/ -v
+```
+- 355+ tests covering all modules
+- 3 skipped (Python version specific)
+
+---
+
+## 🚀 Quick Start
+
+### Install Pre-commit Hooks
+```bash
+# Install pre-commit
+pip install pre-commit
+
+# Install hooks
+pre-commit install
+```
+
+### Run All Checks Manually
+```bash
+# From project root
+make checks
+
+# Or manually:
+ruff check . --fix
+ruff format .
+pyright rewavelink/
+pytest tests/ -v
+```
+
+---
+
+## 📋 Git Hook Configuration
+
+### Manual Setup
+Create a pre-commit hook at `.git/hooks/pre-commit`:
+
+```bash
+#!/bin/bash
+# ReWaveLink pre-commit hook
+
+echo "Running pre-commit checks..."
+
+# Run ruff
+echo "Running ruff..."
+ruff check . --fix
+if [ $? -ne 0 ]; then
+    echo "Ruff check failed!"
+    exit 1
+fi
+
+# Run ruff format
+echo "Running ruff format..."
+ruff format .
+if [ $? -ne 0 ]; then
+    echo "Ruff format failed!"
+    exit 1
+fi
+
+# Run pyright
+echo "Running pyright..."
+pyright rewavelink/
+if [ $? -ne 0 ]; then
+    echo "Pyright type checking failed!"
+    exit 1
+fi
+
+# Run tests
+echo "Running tests..."
+pytest tests/ -v --tb=short
+if [ $? -ne 0 ]; then
+    echo "Tests failed!"
+    exit 1
+fi
+
+echo "All checks passed!"
+exit 0
+```
+
+---
+
+## 🔧 Makefile Commands
+
+Add this to your `Makefile`:
+
+```makefile
+.PHONY: checks format lint type test clean
+
+checks: format lint type test
+
+format:
+	@echo "Running ruff format..."
+	ruff format .
+
+lint:
+	@echo "Running ruff lint..."
+	ruff check . --fix
+
+type:
+	@echo "Running pyright..."
+	pyright rewavelink/
+
+test:
+	@echo "Running pytest..."
+	pytest tests/ -v --tb=short
+
+clean:
+	@echo "Cleaning..."
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+	find . -type f -name "*.pyc" -delete 2>/dev/null || true
+	rm -rf .pytest_cache/ .ruff_cache/
+```
+
+---
+
+## 🎨 Code Style Rules
+
+### Ruff Configuration
+Located in `pyproject.toml`:
+
+```toml
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "UP", "ASYNC", "PYI", "RUF", "TC", "PTH"]
+```
+
+### Pyright Configuration
+Located in `pyproject.toml`:
+
+```toml
+[tool.pyright]
+pythonVersion = "3.10"
+typeCheckingMode = "strict"
+reportMissingImports = true
+```
+
+---
+
+## 📝 Commit Message Format
+
+Follow conventional commits:
+
+```
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer]
+```
+
+### Types
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation
+- `style`: Code style (formatting)
+- `refactor`: Code refactoring
+- `test`: Tests
+- `chore`: Maintenance
+
+### Example
+```
+feat(player): add DAVE protocol E2EE support
+
+- Added davey optional dependency
+- Implemented MLS handshake handlers
+- Added is_e2ee property
+
+Closes #123
+```
+
+---
+
+## 🐛 Troubleshooting
+
+### Pre-commit Fails
+
+1. **Ruff errors**: Run `ruff check . --fix` to auto-fix
+2. **Type errors**: Check pyright output for missing imports/types
+3. **Test failures**: Fix failing tests before committing
+
+### Installation Issues
+
+```bash
+# Reinstall dependencies
+pip install -e ".[dev]"
+
+# Update pre-commit
+pre-commit clean
+pre-commit install -f
+```
+
+---
+
+## 📚 Related Files
+
+- [`pyproject.toml`](../pyproject.toml) - Project configuration
+- [`.pre-commit-config.yaml`](../.pre-commit-config.yaml) - Pre-commit hooks
+- [`changelogs/`](changelogs/) - Change documentation
+- [`REVIVAL_PROGRESS.md`](../REVIVAL_PROGRESS.md) - Project progress
+
+---
+
+## 🔗 References
+
+- [Ruff Documentation](https://docs.astral.sh/ruff/)
+- [Pyright Documentation](https://microsoft.github.io/pyright/)
+- [Pre-commit Documentation](https://pre-commit.com/)

revvlink-3.6.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @justnixx

revvlink-3.6.0/.github/workflows/build_and_publish.yml

@@ -0,0 +1,50 @@
+name: Publish to PyPi @ Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build source and wheels
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: Upload to PyPi
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/ReWaveLink
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to PyPi
+      uses: pypa/gh-action-pypi-publish@release/v1

revvlink-3.6.0/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build_and_publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install build tool
+        run: pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package distributions to TestPyPI
+        uses: pypa/gh-action-pypi-publish@v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@v1

revvlink-3.6.0/.github/workflows/signoff.yaml

@@ -0,0 +1,15 @@
+name: validate-signoff
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: PR Description Check
+        uses: pythonistaguild/pr-description-check@v1.0
+        with:
+          content: "[x] I have read and agree to the [Developer Certificate of Origin]"

revvlink-3.6.0/.github/workflows/sonar_Analysis.yml

@@ -0,0 +1,50 @@
+name: Sonar Analysis
+run-name: Sonar Analysis - ${{ github.ref_name }} by @${{ github.actor }}
+
+on:
+  push:
+    branches:
+      - main
+      - nixx
+  pull_request:
+    branches:
+      - main
+      - nixx
+  workflow_dispatch:
+
+
+jobs:
+  build:
+    name: Build and analyze
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          pip install uv
+          uv pip install --system -e ".[dev]"
+      - name: Run tests with coverage
+        run: pytest --cov=rewavelink --cov-report=xml --cov-report=term-missing
+      - uses: SonarSource/sonarqube-scan-action@v6
+        with:
+          args: >
+            -Dsonar.pullrequest.key=${{ github.event.pull_request.number }}
+            -Dsonar.pullrequest.branch=${{ github.head_ref }}
+            -Dsonar.pullrequest.base=${{ github.base_ref }}
+            -Dsonar.python.coverage.reportPaths=coverage.xml
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+      - name: SonarQube Quality Gate check
+        uses: sonarsource/sonarqube-quality-gate-action@v1
+        timeout-minutes: 5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          

revvlink-3.6.0/.github/workflows/version_checks.yml

@@ -0,0 +1,43 @@
+name: Version Checks
+run-name: Py Version checks - ${{ github.ref_name }} by @${{ github.actor }}
+
+ 
+on:
+  push:
+    branches:
+      - main
+      - dev
+      - nixx
+  pull_request:
+    branches:
+      - main
+      - dev
+      - nixx
+ 
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install uv
+          uv pip install --system -e ".[dev]"
+      - name: Ruff Check
+        run: ruff check .
+      - name: Ruff Format Check
+        run: ruff format --check .
+      - name: Pyright
+        run: pyright
+      - name: Run tests with coverage
+        run: pytest --cov
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4

revvlink-3.6.0/.gitignore

@@ -0,0 +1,168 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+.vscode/
+
+# Linting & Editor caches
+.ruff_cache/
+.DS_Store
+node_modules/
+*roadmap.html

revvlink-3.6.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.0
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format

revvlink-3.6.0/.readthedocs.yml

@@ -0,0 +1,14 @@
+formats: []
+
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools: {"python": "3.10"}
+
+python:
+  install:
+    - requirements: requirements.txt
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

revvlink-3.6.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026-Present @JustNixx and @IamGroot
+
+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.