wzrdbrain 0.1.0__tar.gz

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

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install package and dev deps
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Lint (ruff)
+        run: ruff check .
+      - name: Format check (black)
+        run: black --check .
+      - name: Type check (mypy)
+        run: mypy .
+      - name: Tests (pytest)
+        run: pytest

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

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  id-token: write  # Required for PyPI Trusted Publishing
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+          python -m build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          # To test first against TestPyPI, uncomment the next two lines and add a prerelease:
+          # repository-url: https://test.pypi.org/legacy/
+          # skip-existing: true
+          print-hash: true

wzrdbrain-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.dist/
+build/
+dist/
+.venv/
+.env
+.pytest_cache/
+.mypy_cache/
+.cache/
+.coverage
+htmlcov/
+.ruff_cache/
+# Editors
+.vscode/
+.idea/

wzrdbrain-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,4 @@
+# Code of Conduct
+
+This project follows the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
+By participating in this project, you agree to uphold this code.

wzrdbrain-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing
+
+Thanks for your interest in contributing to wzrdbrain!
+
+- Discuss major changes in an issue before opening a PR.
+- Keep the public API minimal, well-documented, and typed.
+- Run `ruff`, `black`, `mypy`, and `pytest` locally before pushing.
+- Add or update tests for behavior changes.
+
+## Dev setup
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Commit style
+
+- Use clear, concise messages (e.g., `feat: add X`, `fix: correct Y`).
+- Prefer small, focused PRs.

wzrdbrain-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Nazrul Kamaruddin
+
+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.

wzrdbrain-0.1.0/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: wzrdbrain
+Version: 0.1.0
+Summary: Basic APIs to generate tricks for wizard skating.
+Project-URL: Homepage, https://github.com/nazroll/wzrdbrain
+Project-URL: Documentation, https://github.com/nazroll/wzrdbrain#readme
+Project-URL: Repository, https://github.com/nazroll/wzrdbrain
+Project-URL: Issues, https://github.com/nazroll/wzrdbrain/issues
+Author: nazroll
+License: MIT License
+        
+        Copyright (c) 2025 Nazrul Kamaruddin
+        
+        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
+Keywords: generator,inline skating,random,tricks,wizard skating
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: black>=24.3; extra == 'dev'
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# wzrdbrain
+
+Basic APIs to generate tricks for wizard skating.
+
+## Installation
+
+```bash
+pip install wzrdbrain
+```
+
+## Usage
+
+```python
+from wzrdbrain import generate_trick, generate_tricks
+
+# Single trick (random)
+print(generate_trick())  # e.g., "Front Open Lion"
+
+# Multiple tricks
+print(generate_combo(5))  # Maximum of 5 tricks in a combo (duplicates allowed)
+```
+
+## Development
+
+```bash
+# clone your repo
+python -m venv .venv
+source .venv/bin/activate  # on Windows: .venv\Scripts\activate
+pip install -e ".[dev]"
+
+# lint + format
+ruff check .
+black .
+
+# type-check
+mypy .
+
+# tests
+pytest
+```
+
+## Release
+
+1. Update version in `pyproject.toml` and `src/wzrdbrain/__init__.py`.
+2. Create a Git tag and GitHub Release, e.g. `v0.1.0`.
+3. The release workflow will build and publish to PyPI via Trusted Publishing.
+
+## Notes
+
+- Reproducibility: Set `seed` to get the same result across runs.
+- Categories: Use `categories()` to see available groups and restrict generation.
+- Typing: This library ships `py.typed` for type checkers.

wzrdbrain-0.1.0/README.md

@@ -0,0 +1,52 @@
+# wzrdbrain
+
+Basic APIs to generate tricks for wizard skating.
+
+## Installation
+
+```bash
+pip install wzrdbrain
+```
+
+## Usage
+
+```python
+from wzrdbrain import generate_trick, generate_tricks
+
+# Single trick (random)
+print(generate_trick())  # e.g., "Front Open Lion"
+
+# Multiple tricks
+print(generate_combo(5))  # Maximum of 5 tricks in a combo (duplicates allowed)
+```
+
+## Development
+
+```bash
+# clone your repo
+python -m venv .venv
+source .venv/bin/activate  # on Windows: .venv\Scripts\activate
+pip install -e ".[dev]"
+
+# lint + format
+ruff check .
+black .
+
+# type-check
+mypy .
+
+# tests
+pytest
+```
+
+## Release
+
+1. Update version in `pyproject.toml` and `src/wzrdbrain/__init__.py`.
+2. Create a Git tag and GitHub Release, e.g. `v0.1.0`.
+3. The release workflow will build and publish to PyPI via Trusted Publishing.
+
+## Notes
+
+- Reproducibility: Set `seed` to get the same result across runs.
+- Categories: Use `categories()` to see available groups and restrict generation.
+- Typing: This library ships `py.typed` for type checkers.

wzrdbrain-0.1.0/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["hatchling>=1.25"]
+build-backend = "hatchling.build"
+
+[project]
+name = "wzrdbrain"
+version = "0.1.0"
+description = "Basic APIs to generate tricks for wizard skating."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { file = "LICENSE" }
+authors = [
+  { name = "nazroll" }
+]
+keywords = ["wizard skating", "tricks", "random", "generator", "inline skating"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+  "Topic :: Games/Entertainment",
+  "Topic :: Software Development :: Libraries",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8",
+  "ruff>=0.5",
+  "black>=24.3",
+  "mypy>=1.10",
+  "build>=1.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/nazroll/wzrdbrain"
+Documentation = "https://github.com/nazroll/wzrdbrain#readme"
+Repository = "https://github.com/nazroll/wzrdbrain"
+Issues = "https://github.com/nazroll/wzrdbrain/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/wzrdbrain"]
+
+[tool.ruff]
+line-length = 100
+lint.extend-select = ["Q", "UP"]
+lint.extend-ignore = ["E501"]
+
+[tool.black]
+line-length = 100
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"
+
+[tool.mypy]
+strict = true
+warn_unused_ignores = true

wzrdbrain-0.1.0/src/wzrdbrain/__init__.py

@@ -0,0 +1,10 @@
+from .wzrdbrain import generate_combo, generate_trick
+
+"""
+wzrdbrain: Basic APIs to generate tricks for wizard skating.
+"""
+
+
+__all__ = ["generate_trick", "generate_combo"]
+
+__version__ = "0.1.0"

wzrdbrain-0.1.0/src/wzrdbrain/wzrdbrain.py

@@ -0,0 +1,93 @@
+import random
+from typing import Optional
+
+# Trick data definitions
+direction = ["front", "back"]
+stance = ["open", "closed"]
+move = [
+    "predator",
+    "predator one",
+    "parallel",
+    "tree",
+    "gazelle",
+    "gazelle s",
+    "lion",
+    "lion s",
+    "toe press",
+    "heel press",
+    "toe roll",
+    "heel roll",
+    "360",
+    "180",
+    "parallel slide",
+    "soul slide",
+    "acid slide",
+    "mizu slide",
+    "star slide",
+    "fast slide",
+    "back slide",
+]
+exclude_stance = [
+    "predator",
+    "predator one",
+    "toe press",
+    "toe roll",
+    "heel press",
+    "heel roll",
+    "360",
+    "180",
+    "parallel slide",
+    "soul slide",
+    "acid slide",
+    "mizu slide",
+    "star slide",
+    "fast slide",
+    "back slide",
+]
+use_fakie = [
+    "toe press",
+    "toe roll",
+    "heel press",
+    "heel roll",
+    "360",
+    "180",
+    "parallel slide",
+    "soul slide",
+    "acid slide",
+    "mizu slide",
+    "star slide",
+    "fast slide",
+    "back slide",
+]
+
+
+# Generate a trick
+def generate_trick() -> list[str]:
+    selected_move = random.choice(move)
+    trick = [random.choice(direction)]
+
+    if selected_move not in exclude_stance:
+        trick.append(random.choice(stance))
+
+    trick.append(selected_move)
+    return trick
+
+
+# Generate a combination of tricks. Default setting is random, between 1-5 tricks.
+def generate_combo(num_of_tricks: Optional[int] = None) -> list[str]:
+    if num_of_tricks is None:
+        num_of_tricks = random.randint(1, 5)
+
+    trick_line: list[str] = []
+    for i in range(num_of_tricks):
+        trick_parts = generate_trick()
+        # If the move uses the fakie semantics, convert the direction "front"/"back" to "forward"/"fakie"
+        if trick_parts:
+            move_name = trick_parts[-1]
+            if move_name in use_fakie:
+                if trick_parts[0] == "back":
+                    trick_parts[0] = "fakie"
+                elif trick_parts[0] == "front":
+                    trick_parts[0] = "forward"
+        trick_line.append(" ".join(trick_parts))
+    return trick_line

wzrdbrain-0.1.0/tests/test_wzrdbrain.py

@@ -0,0 +1,75 @@
+from pathlib import Path
+import sys
+from collections.abc import Iterator, Sequence
+
+import pytest
+
+# Ensure src is on path so we can import the module under test
+ROOT = Path(__file__).resolve().parents[1]
+SRC = ROOT / "src"
+sys.path.insert(0, str(SRC))
+
+import wzrdbrain.wzrdbrain as wb  # noqa: E402
+
+
+def test_generate_trick_exclude_stance(monkeypatch: pytest.MonkeyPatch) -> None:
+    # Force choices so selected_move is in exclude_stance ('predator')
+    def fake_choice(seq: Sequence[str]) -> str:
+        if seq is wb.move:
+            return "predator"
+        if seq is wb.direction:
+            return "front"
+        if seq is wb.stance:
+            return "open"
+        raise RuntimeError("unexpected seq")
+
+    # patch the module-level random.choice by target string to avoid mypy attr warnings
+    monkeypatch.setattr("wzrdbrain.wzrdbrain.random.choice", fake_choice)
+    trick = wb.generate_trick()
+    assert trick == ["front", "predator"]
+
+
+def test_generate_trick_with_stance(monkeypatch: pytest.MonkeyPatch) -> None:
+    # Force choices so selected_move is NOT in exclude_stance ('parallel')
+    def fake_choice(seq: Sequence[str]) -> str:
+        if seq is wb.move:
+            return "parallel"
+        if seq is wb.direction:
+            return "back"
+        if seq is wb.stance:
+            return "open"
+        raise RuntimeError("unexpected seq")
+
+    monkeypatch.setattr("wzrdbrain.wzrdbrain.random.choice", fake_choice)
+    trick = wb.generate_trick()
+    assert trick == ["back", "open", "parallel"]
+
+
+def test_generate_combo_fakie_conversion(monkeypatch: pytest.MonkeyPatch) -> None:
+    # Provide deterministic successive generate_trick outputs to test fakie/forward conversion
+    seq: Iterator[list[str]] = iter(
+        [
+            ["front", "parallel"],  # not in use_fakie -> unchanged
+            ["back", "toe press"],  # in use_fakie -> back -> fakie (since it's subsequent)
+            ["front", "360"],  # in use_fakie -> front -> forward
+        ]
+    )
+
+    def fake_generate_trick() -> list[str]:
+        return next(seq)
+
+    monkeypatch.setattr(wb, "generate_trick", fake_generate_trick)
+    line = wb.generate_combo(3)
+    assert line == [
+        "front parallel",
+        "fakie toe press",
+        "forward 360",
+    ]
+
+
+def test_generate_combo_default_length() -> None:
+    # Default should produce between 1 and 5 tricks
+    line = wb.generate_combo()
+    assert 1 <= len(line) <= 5
+    for item in line:
+        assert isinstance(item, str)