fluxwave 0.1.0__tar.gz

fluxwave-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: Bug report
+about: Report something not working as expected
+title: "[Bug] "
+labels: bug
+---
+
+## Description
+
+A clear description of the bug.
+
+## Reproduction
+
+A minimal code snippet that triggers it. **Do not include real bot tokens or
+Lavalink passwords.**
+
+```python
+# ...
+```
+
+## Expected vs actual behavior
+
+What you expected to happen, and what actually happened.
+
+## Traceback / logs
+
+```
+paste the full traceback here
+```
+
+## Environment
+
+- FluxWave version:
+- Python version:
+- Discord library + version (discord.py / py-cord / nextcord / disnake):
+- Lavalink version (`GET /version`):
+- OS:
+
+## Additional context
+
+Anything else that might help (plugins installed, multi-node setup, etc.).

fluxwave-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Question / usage help
+    url: https://github.com/NobitaDeveloper/fluxwave/discussions
+    about: Ask questions and get help here instead of opening an issue.
+  - name: Documentation
+    url: https://github.com/NobitaDeveloper/fluxwave/tree/main/docs
+    about: Guides, API reference, and the FAQ.

fluxwave-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea or improvement
+title: "[Feature] "
+labels: enhancement
+---
+
+## Problem
+
+What are you trying to do that FluxWave doesn't support today?
+
+## Proposed solution
+
+The API or behavior you'd like. Sketch a usage example if you can:
+
+```python
+# ...
+```
+
+## Alternatives considered
+
+Other approaches or existing workarounds.
+
+## Additional context
+
+Links to how other clients (wavelink, pomice, lavalink.py) handle this, if
+relevant.

fluxwave-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,22 @@
+## What does this PR do?
+
+Brief description of the change and the motivation.
+
+Fixes #(issue) <!-- if applicable -->
+
+## Type of change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Breaking change
+- [ ] Docs / internal only
+
+## Checklist
+
+- [ ] `ruff check .` passes
+- [ ] `ruff format --check .` passes
+- [ ] `mypy` passes
+- [ ] `pytest` passes
+- [ ] Added/updated tests (a bug fix includes a regression test)
+- [ ] Updated docs for any public API change
+- [ ] No secrets (tokens/passwords) committed

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

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: python -m pip install -e ".[dev]"
+      - name: Ruff
+        run: ruff check .
+      - name: Format
+        run: ruff format --check .
+      - name: Mypy
+        run: mypy
+      - name: Tests
+        run: pytest

fluxwave-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,61 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install build
+        run: python -m pip install build
+      - name: Build distributions
+        run: python -m build
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  pypi-publish:
+    needs: build
+    runs-on: ubuntu-latest
+    # Configure a "pypi" environment with a PyPI trusted publisher for this repo
+    # and the release.yml workflow. No API token needed — OIDC handles auth.
+    environment:
+      name: pypi
+      url: https://pypi.org/p/fluxwave
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

fluxwave-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.venv/
+build/
+dist/
+docs/_build/
+mytestbot.py

fluxwave-0.1.0/.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration. https://docs.readthedocs.io/en/stable/config-file/v2.html
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+# Install the package with its docs extra (Sphinx + MyST + furo). The package
+# itself depends only on aiohttp; no Discord library is needed to build the docs.
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+formats:
+  - pdf

fluxwave-0.1.0/CHANGELOG.md

@@ -0,0 +1,76 @@
+# Changelog
+
+All notable changes to FluxWave are documented in this file. The format is based
+on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project aims
+to follow [Semantic Versioning](https://semver.org/) once it reaches `1.0`.
+
+## [0.1.0a0] — 2026-05-29
+
+First public pre-release. The core API is usable for beta bots and testing;
+public APIs may still change before `1.0`. Requires Python 3.11+, `aiohttp`, a
+Lavalink v4 server, and any one of discord.py / py-cord / nextcord / disnake.
+
+### Core
+
+- Async Lavalink v4 client with a typed REST layer and a websocket event layer
+  (ready / stats / playerUpdate / events, session resume, jittered reconnect).
+- Library-agnostic: FluxWave depends only on `aiohttp` and auto-detects whichever
+  Discord library is installed (discord.py, py-cord, nextcord, or disnake).
+  `FLUXWAVE_DISCORD_LIBRARY` / `FLUXWAVE_IGNORE_LIBRARY_CHECK` override detection.
+- Strict typing throughout with a `py.typed` marker.
+- Connect-time Lavalink version validation with clear unsupported/newer warnings.
+
+### Nodes and pools
+
+- `Node` owns one Lavalink server; `NodePool` is instance-first and the global
+  `Pool` facade offers wavelink-style helpers (every `Pool` member is a classmethod,
+  called as `Pool.x(...)`).
+- Health-aware selection with region/shard awareness (`NodeSelectionStrategy`),
+  blacklist/cooldowns, degraded-node detection, parallel multi-node `search_all`,
+  and graceful `drain`.
+- Automatic player migration on node failure and return-to-home-node once a failed
+  node recovers.
+- LFU search cache plus in-flight request coalescing so concurrent identical
+  searches share a single Lavalink request.
+
+### Players and playback
+
+- `FluxPlayer` is a Discord `VoiceProtocol`: `channel.connect(cls=fluxwave.FluxPlayer)`
+  resolves a node from the connected `Pool` automatically.
+- `play`, `enqueue`, `play_search`, `play_next`, `skip`, `stop`, `pause`, `resume`,
+  `seek`, `set_volume`, `move_to`, `switch_node`, `disconnect`/`destroy`.
+- Position tracking, voice-state recovery, empty-channel auto-pause/resume/disconnect,
+  and Pomice-style state aliases (`is_connected`, `is_playing`, `is_paused`, `is_dead`).
+
+### Queue and filters
+
+- Queue with history, loop modes, async waiters, move/shuffle/dedupe, range clearing,
+  search, total duration, capacity limits, and raw serialization round-trips.
+- Lavalink filters with ergonomic components, presets (nightcore, vaporwave,
+  bass boost), `set_filters(..., seek=True)`, a tagged filter stack, and interpolation.
+
+### Search, events, and plugins
+
+- Search helpers for `ytsearch:`/`ytmsearch:`/`scsearch:`/etc., direct URLs,
+  playlists, empty results, and load errors, with default-source prefixing.
+- Typed public events with both `fluxwave_*` and wavelink-style aliases, a raw
+  websocket event, and global `listen`/`dispatch` helpers.
+- Plugin helpers for LavaLyrics, LavaSrc, and SponsorBlock, plus custom REST routes.
+
+### Autoplay, persistence, and observability
+
+- Autoplay with provider-based recommendations, duplicate filtering, and a partial
+  mode (`AutoPlayMode`).
+- Player state persistence via `save_state`/`restore_state`, a `MemoryStore`, and a
+  crash-safe on-disk `FileStore`.
+- `VoiceWatchdog` for stalled-playback recovery, `WrapperMetrics` operation counters,
+  and an `EventTracer` — all wired into live operations.
+- `SourceRouter` for glob-based per-source node routing.
+
+### Tooling
+
+- `python -m fluxwave --version` diagnostics CLI.
+- Library-agnostic display helpers (`progress_bar`, `format_duration`,
+  `paginate_queue`).
+- Documentation site, beginner and advanced example bots, and a `release.yml`
+  publish pipeline.

fluxwave-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing to FluxWave
+
+Thanks for your interest in improving FluxWave! This guide covers the local
+setup and the checks every change must pass.
+
+## Development setup
+
+FluxWave targets Python 3.11+. Clone the repo and install the dev extras into a
+virtual environment:
+
+```bash
+git clone https://github.com/NobitaDeveloper/fluxwave.git
+cd fluxwave
+python -m venv .venv
+source .venv/bin/activate        # Windows: .venv\Scripts\activate
+python -m pip install -e ".[dev,docs]"
+```
+
+The `dev` extra installs `discord.py` so the test suite has a Discord library to
+run against. FluxWave itself works with discord.py, py-cord, nextcord, or disnake.
+
+## Checks
+
+CI runs these on every push and pull request (Python 3.11–3.14). Run them locally
+before opening a PR:
+
+```bash
+ruff check .            # lint
+ruff format --check .   # formatting
+mypy                    # strict type checking
+pytest                  # unit tests
+```
+
+`ruff format .` will auto-format your changes.
+
+## Tests
+
+- Unit tests live in `tests/` and must not require a network connection.
+- Add or update tests for any behavior change; bug fixes should include a
+  regression test that fails before the fix.
+- Integration tests are marked `@pytest.mark.integration` and require a real
+  Lavalink v4 server:
+
+  ```bash
+  LAVALINK_HOST=127.0.0.1 LAVALINK_PORT=2333 LAVALINK_PASSWORD=youshallnotpass \
+  LAVALINK_SECURE=false pytest -m integration tests/test_integration_lavalink.py
+  ```
+
+## Pull requests
+
+1. Branch off `main`.
+2. Keep changes focused; one logical change per PR.
+3. Make sure all four checks above pass and docs are updated if you changed the
+   public API.
+4. Describe what changed and why in the PR body.
+
+## Reporting bugs
+
+Open a [GitHub issue](https://github.com/NobitaDeveloper/fluxwave/issues)
+with FluxWave/Python/Lavalink versions, a minimal reproduction, and the full
+traceback. Never paste real bot tokens or Lavalink passwords.
+
+## Code style
+
+- Strictly typed (`mypy --strict`, `py.typed`); add precise type hints.
+- Match the surrounding code's naming and structure.
+- Public API additions should be exported from `fluxwave/__init__.py` and
+  documented under `docs/`.

fluxwave-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FluxWave Contributors
+
+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.