wzrdbrain 0.1.2__tar.gz → 0.1.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,107 @@
1
+ Metadata-Version: 2.4
2
+ Name: wzrdbrain
3
+ Version: 0.1.4
4
+ Summary: A simple library to generate trick combinations for wizard skating.
5
+ Author: nazroll
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/nazroll/wzrdbrain
8
+ Project-URL: Documentation, https://github.com/nazroll/wzrdbrain#readme
9
+ Project-URL: Repository, https://github.com/nazroll/wzrdbrain
10
+ Project-URL: Issues, https://github.com/nazroll/wzrdbrain/issues
11
+ Keywords: wizard skating,tricks,random,generator,inline skating
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Topic :: Games/Entertainment
14
+ Classifier: Topic :: Software Development :: Libraries
15
+ Requires-Python: >=3.9
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Provides-Extra: dev
19
+ Requires-Dist: pytest; extra == "dev"
20
+ Requires-Dist: ruff; extra == "dev"
21
+ Requires-Dist: black; extra == "dev"
22
+ Requires-Dist: mypy; extra == "dev"
23
+ Requires-Dist: build; extra == "dev"
24
+ Dynamic: license-file
25
+
26
+ # wzrdbrain
27
+
28
+ A library to generate random trick combinations for wizard skating.
29
+
30
+ ## Installation
31
+
32
+ ```bash
33
+ pip install wzrdbrain
34
+ ```
35
+
36
+ ## Usage
37
+
38
+ The primary function is `generate_combo`, which returns a list of trick dictionaries. You can also create `Trick` objects directly for more control.
39
+
40
+ ```python
41
+ from wzrdbrain import generate_combo, Trick
42
+
43
+ # Generate a combo of 3 tricks
44
+ combo = generate_combo(3)
45
+
46
+ # The output is a list of dictionaries, each representing a trick
47
+ # print(combo)
48
+ # Example output:
49
+ # [
50
+ # {
51
+ # 'direction': 'front', 'stance': 'open', 'move': 'gazelle',
52
+ # 'enter_into_trick': 'front', 'exit_from_trick': 'back',
53
+ # 'name': 'front open gazelle'
54
+ # },
55
+ # {
56
+ # 'direction': 'back', 'stance': None, 'move': '360',
57
+ # 'enter_into_trick': 'back', 'exit_from_trick': 'back',
58
+ # 'name': 'fakie 360'
59
+ # },
60
+ # # ... and so on
61
+ # ]
62
+
63
+ # To get just the names of the tricks in the combo:
64
+ trick_names = [trick['name'] for trick in combo]
65
+ print(trick_names)
66
+ # Example output: ['front open gazelle', 'fakie 360', 'back open lion']
67
+ ```
68
+
69
+ ### Creating a Trick Object
70
+
71
+ You can create a `Trick` object with specific attributes. Any attributes not provided will be randomly generated.
72
+
73
+ ```python
74
+ # Create a trick with a specific move
75
+ my_trick = Trick(move="lion s")
76
+
77
+ # Print the full trick object as a dictionary
78
+ print(my_trick.to_dict())
79
+ # Example output:
80
+ # {
81
+ # 'direction': 'back', 'stance': 'closed', 'move': 'lion s',
82
+ # 'enter_into_trick': 'back', 'exit_from_trick': 'back',
83
+ # 'name': 'back closed lion s'
84
+ # }
85
+ ```
86
+
87
+ ## Development
88
+
89
+ To contribute to this project, please see the [Contributing Guide](CONTRIBUTING.md).
90
+
91
+ First, clone the repository and install the project in editable mode with its development dependencies:
92
+
93
+ ```bash
94
+ git clone https://github.com/nazroll/wzrdbrain.git
95
+ cd wzrdbrain
96
+ pip install -e .[dev]
97
+ ```
98
+
99
+ You can run the test suite using `pytest`:
100
+
101
+ ```bash
102
+ pytest
103
+ ```
104
+
105
+ ## List of wizard skating tricks
106
+
107
+ The list of tricks in this library is not comprehensive. Please create an issue and give us your suggestions of new tricks
@@ -0,0 +1,82 @@
1
+ # wzrdbrain
2
+
3
+ A library to generate random trick combinations for wizard skating.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ pip install wzrdbrain
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ The primary function is `generate_combo`, which returns a list of trick dictionaries. You can also create `Trick` objects directly for more control.
14
+
15
+ ```python
16
+ from wzrdbrain import generate_combo, Trick
17
+
18
+ # Generate a combo of 3 tricks
19
+ combo = generate_combo(3)
20
+
21
+ # The output is a list of dictionaries, each representing a trick
22
+ # print(combo)
23
+ # Example output:
24
+ # [
25
+ # {
26
+ # 'direction': 'front', 'stance': 'open', 'move': 'gazelle',
27
+ # 'enter_into_trick': 'front', 'exit_from_trick': 'back',
28
+ # 'name': 'front open gazelle'
29
+ # },
30
+ # {
31
+ # 'direction': 'back', 'stance': None, 'move': '360',
32
+ # 'enter_into_trick': 'back', 'exit_from_trick': 'back',
33
+ # 'name': 'fakie 360'
34
+ # },
35
+ # # ... and so on
36
+ # ]
37
+
38
+ # To get just the names of the tricks in the combo:
39
+ trick_names = [trick['name'] for trick in combo]
40
+ print(trick_names)
41
+ # Example output: ['front open gazelle', 'fakie 360', 'back open lion']
42
+ ```
43
+
44
+ ### Creating a Trick Object
45
+
46
+ You can create a `Trick` object with specific attributes. Any attributes not provided will be randomly generated.
47
+
48
+ ```python
49
+ # Create a trick with a specific move
50
+ my_trick = Trick(move="lion s")
51
+
52
+ # Print the full trick object as a dictionary
53
+ print(my_trick.to_dict())
54
+ # Example output:
55
+ # {
56
+ # 'direction': 'back', 'stance': 'closed', 'move': 'lion s',
57
+ # 'enter_into_trick': 'back', 'exit_from_trick': 'back',
58
+ # 'name': 'back closed lion s'
59
+ # }
60
+ ```
61
+
62
+ ## Development
63
+
64
+ To contribute to this project, please see the [Contributing Guide](CONTRIBUTING.md).
65
+
66
+ First, clone the repository and install the project in editable mode with its development dependencies:
67
+
68
+ ```bash
69
+ git clone https://github.com/nazroll/wzrdbrain.git
70
+ cd wzrdbrain
71
+ pip install -e .[dev]
72
+ ```
73
+
74
+ You can run the test suite using `pytest`:
75
+
76
+ ```bash
77
+ pytest
78
+ ```
79
+
80
+ ## List of wizard skating tricks
81
+
82
+ The list of tricks in this library is not comprehensive. Please create an issue and give us your suggestions of new tricks
@@ -1,42 +1,31 @@
1
1
  [build-system]
2
- requires = ["hatchling>=1.25"]
3
- build-backend = "hatchling.build"
2
+ requires = ["setuptools>=61.0"]
3
+ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "wzrdbrain"
7
- version = "0.1.2"
8
- description = "Basic APIs to generate tricks for wizard skating."
7
+ version = "0.1.4"
8
+ description = "A simple library to generate trick combinations for wizard skating."
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.9"
11
- license = { file = "LICENSE" }
11
+ license = "Apache-2.0"
12
12
  authors = [
13
13
  { name = "nazroll" }
14
14
  ]
15
15
  keywords = ["wizard skating", "tricks", "random", "generator", "inline skating"]
16
16
  classifiers = [
17
- "Development Status :: 3 - Alpha",
18
- "Intended Audience :: Developers",
19
- "License :: OSI Approved :: MIT License",
20
- "Programming Language :: Python",
21
17
  "Programming Language :: Python :: 3",
22
- "Programming Language :: Python :: 3 :: Only",
23
- "Programming Language :: Python :: 3.9",
24
- "Programming Language :: Python :: 3.10",
25
- "Programming Language :: Python :: 3.11",
26
- "Programming Language :: Python :: 3.12",
27
- "Programming Language :: Python :: 3.13",
28
- "Typing :: Typed",
29
18
  "Topic :: Games/Entertainment",
30
19
  "Topic :: Software Development :: Libraries",
31
20
  ]
32
21
 
33
22
  [project.optional-dependencies]
34
23
  dev = [
35
- "pytest>=8",
36
- "ruff>=0.5",
37
- "black>=24.3",
38
- "mypy>=1.10",
39
- "build>=1.2",
24
+ "pytest",
25
+ "ruff",
26
+ "black",
27
+ "mypy",
28
+ "build"
40
29
  ]
41
30
 
42
31
  [project.urls]
@@ -57,9 +46,12 @@ lint.extend-ignore = ["E501"]
57
46
  line-length = 100
58
47
 
59
48
  [tool.pytest.ini_options]
49
+ pythonpath = ["src"]
60
50
  testpaths = ["tests"]
61
- addopts = "-q"
62
51
 
63
52
  [tool.mypy]
64
53
  strict = true
65
54
  warn_unused_ignores = true
55
+
56
+ [tool.setuptools.packages.find]
57
+ where = ["src"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,10 @@
1
+ from .wzrdbrain import generate_combo
2
+
3
+ """
4
+ wzrdbrain: Basic APIs to generate tricks for wizard skating.
5
+ """
6
+
7
+
8
+ __all__ = ["generate_combo"]
9
+
10
+ __version__ = "0.1.0"
@@ -0,0 +1,159 @@
1
+ import random
2
+ from typing import Optional, Any
3
+ from dataclasses import dataclass, asdict
4
+
5
+ # Trick data definitions
6
+ DIRECTIONS = ("front", "back")
7
+ STANCES = ("open", "closed")
8
+ MOVES = (
9
+ "predator",
10
+ "predator one",
11
+ "parallel",
12
+ "tree",
13
+ "gazelle",
14
+ "gazelle s",
15
+ "lion",
16
+ "lion s",
17
+ "toe press",
18
+ "heel press",
19
+ "toe roll",
20
+ "heel roll",
21
+ "360",
22
+ "180",
23
+ "540", # Added missing move
24
+ "parallel slide",
25
+ "soul slide",
26
+ "acid slide",
27
+ "mizu slide",
28
+ "star slide",
29
+ "fast slide",
30
+ "back slide",
31
+ )
32
+ # Moves that only occurs as the first trick for a combo
33
+ only_first = {"predator", "predator one", "parallel"}
34
+
35
+ # Moves that use "fakie" instead of "back"
36
+ use_fakie = {
37
+ "toe press",
38
+ "toe roll",
39
+ "heel press",
40
+ "heel roll",
41
+ "360",
42
+ "180",
43
+ "540",
44
+ "parallel slide",
45
+ "soul slide",
46
+ "acid slide",
47
+ "mizu slide",
48
+ "star slide",
49
+ "fast slide",
50
+ "back slide",
51
+ }
52
+
53
+ # Moves that don't have an open/closed stance
54
+ exclude_stance = {
55
+ "predator",
56
+ "predator one",
57
+ }.union(use_fakie)
58
+
59
+
60
+ @dataclass
61
+ class Trick:
62
+ direction: Optional[str] = None
63
+ stance: Optional[str] = None
64
+ move: Optional[str] = None
65
+ enter_into_trick: Optional[str] = None
66
+ exit_from_trick: Optional[str] = None
67
+
68
+ def __post_init__(self) -> None:
69
+ """
70
+ Validate inputs and set random defaults for any attributes that were not provided.
71
+ """
72
+ # Input validation
73
+ if self.direction is not None and self.direction not in DIRECTIONS:
74
+ raise ValueError(f"Invalid direction: '{self.direction}'. Must be one of {DIRECTIONS}")
75
+ if self.stance is not None and self.stance not in STANCES:
76
+ raise ValueError(f"Invalid stance: '{self.stance}'. Must be one of {STANCES}")
77
+ if self.move is not None and self.move not in MOVES:
78
+ raise ValueError(f"Invalid move: '{self.move}'. Must be one of {MOVES}")
79
+
80
+ # Generate default values
81
+ if self.direction is None:
82
+ self.direction = random.choice(DIRECTIONS)
83
+
84
+ if self.move is None:
85
+ self.move = random.choice(MOVES)
86
+
87
+ if self.enter_into_trick is None:
88
+ self.enter_into_trick = self.direction
89
+
90
+ if self.exit_from_trick is None:
91
+ self.exit_from_trick = self.direction
92
+
93
+ # Automatically determine stance if not provided
94
+ if self.stance is None and self.move not in exclude_stance:
95
+ self.stance = random.choice(STANCES)
96
+
97
+ # Update exit direction for moves that rotate the body
98
+ if self.move in ["gazelle", "lion", "180", "540"]:
99
+ if self.direction == "back":
100
+ self.exit_from_trick = "front"
101
+ elif self.direction == "front":
102
+ self.exit_from_trick = "back"
103
+
104
+ def __str__(self) -> str:
105
+ parts = []
106
+ display_direction = self.direction
107
+ # Handle fakie/forward display name
108
+ if self.move in use_fakie:
109
+ if self.direction == "back":
110
+ display_direction = "fakie"
111
+ elif self.direction == "front":
112
+ display_direction = "forward"
113
+
114
+ if display_direction:
115
+ parts.append(display_direction)
116
+ if self.stance:
117
+ parts.append(self.stance)
118
+ if self.move:
119
+ parts.append(self.move)
120
+
121
+ return " ".join(parts)
122
+
123
+ def to_dict(self) -> dict[str, Any]:
124
+ """Returns a dictionary representation of the trick, including its full name."""
125
+ data = asdict(self)
126
+ data["name"] = str(self)
127
+ return data
128
+
129
+
130
+ # Generate a combination of tricks. Default is a random number from 2 until 5.
131
+ def generate_combo(num_of_tricks: Optional[int] = None) -> list[dict[str, Any]]:
132
+ if num_of_tricks is None:
133
+ num_of_tricks = random.randint(2, 5)
134
+
135
+ if num_of_tricks <= 0:
136
+ return []
137
+
138
+ trick_objects: list[Trick] = []
139
+ previous_trick: Optional[Trick] = None
140
+
141
+ for _ in range(num_of_tricks):
142
+ if previous_trick is None:
143
+ # Generate the first trick without constraints
144
+ new_trick = Trick()
145
+ else:
146
+ # Generate subsequent tricks based on the previous one's exit
147
+ required_direction = previous_trick.exit_from_trick
148
+ # Loop until we generate a valid trick for this position
149
+ while True:
150
+ candidate_trick = Trick(direction=required_direction)
151
+ if candidate_trick.move not in only_first:
152
+ new_trick = candidate_trick
153
+ break
154
+
155
+ trick_objects.append(new_trick)
156
+ previous_trick = new_trick
157
+
158
+ # Convert all trick objects to dictionaries for the final output
159
+ return [trick.to_dict() for trick in trick_objects]
@@ -0,0 +1,107 @@
1
+ Metadata-Version: 2.4
2
+ Name: wzrdbrain
3
+ Version: 0.1.4
4
+ Summary: A simple library to generate trick combinations for wizard skating.
5
+ Author: nazroll
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/nazroll/wzrdbrain
8
+ Project-URL: Documentation, https://github.com/nazroll/wzrdbrain#readme
9
+ Project-URL: Repository, https://github.com/nazroll/wzrdbrain
10
+ Project-URL: Issues, https://github.com/nazroll/wzrdbrain/issues
11
+ Keywords: wizard skating,tricks,random,generator,inline skating
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Topic :: Games/Entertainment
14
+ Classifier: Topic :: Software Development :: Libraries
15
+ Requires-Python: >=3.9
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ Provides-Extra: dev
19
+ Requires-Dist: pytest; extra == "dev"
20
+ Requires-Dist: ruff; extra == "dev"
21
+ Requires-Dist: black; extra == "dev"
22
+ Requires-Dist: mypy; extra == "dev"
23
+ Requires-Dist: build; extra == "dev"
24
+ Dynamic: license-file
25
+
26
+ # wzrdbrain
27
+
28
+ A library to generate random trick combinations for wizard skating.
29
+
30
+ ## Installation
31
+
32
+ ```bash
33
+ pip install wzrdbrain
34
+ ```
35
+
36
+ ## Usage
37
+
38
+ The primary function is `generate_combo`, which returns a list of trick dictionaries. You can also create `Trick` objects directly for more control.
39
+
40
+ ```python
41
+ from wzrdbrain import generate_combo, Trick
42
+
43
+ # Generate a combo of 3 tricks
44
+ combo = generate_combo(3)
45
+
46
+ # The output is a list of dictionaries, each representing a trick
47
+ # print(combo)
48
+ # Example output:
49
+ # [
50
+ # {
51
+ # 'direction': 'front', 'stance': 'open', 'move': 'gazelle',
52
+ # 'enter_into_trick': 'front', 'exit_from_trick': 'back',
53
+ # 'name': 'front open gazelle'
54
+ # },
55
+ # {
56
+ # 'direction': 'back', 'stance': None, 'move': '360',
57
+ # 'enter_into_trick': 'back', 'exit_from_trick': 'back',
58
+ # 'name': 'fakie 360'
59
+ # },
60
+ # # ... and so on
61
+ # ]
62
+
63
+ # To get just the names of the tricks in the combo:
64
+ trick_names = [trick['name'] for trick in combo]
65
+ print(trick_names)
66
+ # Example output: ['front open gazelle', 'fakie 360', 'back open lion']
67
+ ```
68
+
69
+ ### Creating a Trick Object
70
+
71
+ You can create a `Trick` object with specific attributes. Any attributes not provided will be randomly generated.
72
+
73
+ ```python
74
+ # Create a trick with a specific move
75
+ my_trick = Trick(move="lion s")
76
+
77
+ # Print the full trick object as a dictionary
78
+ print(my_trick.to_dict())
79
+ # Example output:
80
+ # {
81
+ # 'direction': 'back', 'stance': 'closed', 'move': 'lion s',
82
+ # 'enter_into_trick': 'back', 'exit_from_trick': 'back',
83
+ # 'name': 'back closed lion s'
84
+ # }
85
+ ```
86
+
87
+ ## Development
88
+
89
+ To contribute to this project, please see the [Contributing Guide](CONTRIBUTING.md).
90
+
91
+ First, clone the repository and install the project in editable mode with its development dependencies:
92
+
93
+ ```bash
94
+ git clone https://github.com/nazroll/wzrdbrain.git
95
+ cd wzrdbrain
96
+ pip install -e .[dev]
97
+ ```
98
+
99
+ You can run the test suite using `pytest`:
100
+
101
+ ```bash
102
+ pytest
103
+ ```
104
+
105
+ ## List of wizard skating tricks
106
+
107
+ The list of tricks in this library is not comprehensive. Please create an issue and give us your suggestions of new tricks
@@ -0,0 +1,11 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/wzrdbrain/__init__.py
5
+ src/wzrdbrain/wzrdbrain.py
6
+ src/wzrdbrain.egg-info/PKG-INFO
7
+ src/wzrdbrain.egg-info/SOURCES.txt
8
+ src/wzrdbrain.egg-info/dependency_links.txt
9
+ src/wzrdbrain.egg-info/requires.txt
10
+ src/wzrdbrain.egg-info/top_level.txt
11
+ tests/test_wzrdbrain.py
@@ -0,0 +1,7 @@
1
+
2
+ [dev]
3
+ pytest
4
+ ruff
5
+ black
6
+ mypy
7
+ build
@@ -0,0 +1 @@
1
+ wzrdbrain
@@ -0,0 +1,77 @@
1
+ import pytest
2
+ from wzrdbrain.wzrdbrain import Trick, generate_combo, DIRECTIONS, MOVES, STANCES, only_first
3
+
4
+
5
+ def test_trick_creation_with_validation() -> None:
6
+ """Test that creating a Trick with invalid data raises a ValueError."""
7
+ with pytest.raises(ValueError, match="Invalid move"):
8
+ Trick(move="invalid_move")
9
+ with pytest.raises(ValueError, match="Invalid direction"):
10
+ Trick(direction="invalid_direction")
11
+ with pytest.raises(ValueError, match="Invalid stance"):
12
+ Trick(stance="invalid_stance")
13
+
14
+
15
+ def test_trick_default_creation() -> None:
16
+ """Test creating a Trick with no arguments uses random defaults."""
17
+ trick = Trick()
18
+ assert isinstance(trick, Trick)
19
+ assert trick.move in MOVES
20
+ assert trick.direction in DIRECTIONS
21
+ if trick.move not in {"predator", "predator one"}:
22
+ # Stance should be None for predator moves, otherwise it should be set
23
+ if trick.stance:
24
+ assert trick.stance in STANCES
25
+
26
+
27
+ def test_trick_str_representation() -> None:
28
+ """Test the string formatting of a Trick, including the 'fakie' logic."""
29
+ trick1 = Trick(direction="front", stance="open", move="gazelle")
30
+ assert str(trick1) == "front open gazelle"
31
+
32
+ trick2 = Trick(direction="back", move="360")
33
+ assert str(trick2) == "fakie 360"
34
+
35
+ trick3 = Trick(direction="front", move="soul slide")
36
+ assert str(trick3) == "forward soul slide"
37
+
38
+
39
+ def test_trick_to_dict() -> None:
40
+ """Test the to_dict method includes the 'name' key."""
41
+ trick = Trick(direction="front", stance="open", move="gazelle")
42
+ trick_dict = trick.to_dict()
43
+ assert isinstance(trick_dict, dict)
44
+ assert "name" in trick_dict
45
+ assert trick_dict["name"] == "front open gazelle"
46
+ assert trick_dict["move"] == "gazelle"
47
+
48
+
49
+ def test_generate_combo_returns_list_of_dicts() -> None:
50
+ """Test that generate_combo returns a list of trick dictionaries."""
51
+ combo = generate_combo(3)
52
+ assert isinstance(combo, list)
53
+ assert len(combo) == 3
54
+ for trick_dict in combo:
55
+ assert isinstance(trick_dict, dict)
56
+ assert "name" in trick_dict
57
+ assert "move" in trick_dict
58
+
59
+
60
+ def test_generate_combo_linking() -> None:
61
+ """Test that tricks in a combo are linked by their exit/enter directions."""
62
+ # Generate a long combo to increase the chance of seeing rotation
63
+ combo = generate_combo(10)
64
+ for i in range(len(combo) - 1):
65
+ current_trick = combo[i]
66
+ next_trick = combo[i + 1]
67
+ assert current_trick["exit_from_trick"] == next_trick["enter_into_trick"]
68
+
69
+
70
+ def test_generate_combo_only_first_rule() -> None:
71
+ """Test that moves in 'only_first' do not appear after the first trick."""
72
+ # Run multiple times to ensure rule is consistently applied
73
+ for _ in range(10):
74
+ combo = generate_combo(5)
75
+ # Check all tricks after the first one
76
+ for trick_dict in combo[1:]:
77
+ assert trick_dict["move"] not in only_first
@@ -1,30 +0,0 @@
1
- name: CI
2
-
3
- on:
4
- push:
5
- branches: ["**"]
6
- pull_request:
7
-
8
- jobs:
9
- test:
10
- runs-on: ubuntu-latest
11
- strategy:
12
- matrix:
13
- python-version: ["3.9", "3.10", "3.11", "3.12"]
14
- steps:
15
- - uses: actions/checkout@v4
16
- - uses: actions/setup-python@v5
17
- with:
18
- python-version: ${{ matrix.python-version }}
19
- - name: Install package and dev deps
20
- run: |
21
- python -m pip install --upgrade pip
22
- pip install -e ".[dev]"
23
- - name: Lint (ruff)
24
- run: ruff check .
25
- - name: Format check (black)
26
- run: black --check .
27
- - name: Type check (mypy)
28
- run: mypy .
29
- - name: Tests (pytest)
30
- run: pytest
@@ -1,30 +0,0 @@
1
- name: Release
2
-
3
- on:
4
- release:
5
- types: [published]
6
-
7
- permissions:
8
- contents: read
9
- id-token: write # Required for PyPI Trusted Publishing
10
-
11
- jobs:
12
- build-and-publish:
13
- runs-on: ubuntu-latest
14
- steps:
15
- - uses: actions/checkout@v4
16
- - uses: actions/setup-python@v5
17
- with:
18
- python-version: "3.12"
19
- - name: Build
20
- run: |
21
- python -m pip install --upgrade pip
22
- pip install build
23
- python -m build
24
- - name: Publish to PyPI
25
- uses: pypa/gh-action-pypi-publish@release/v1
26
- with:
27
- # To test first against TestPyPI, uncomment the next two lines and add a prerelease:
28
- # repository-url: https://test.pypi.org/legacy/
29
- # skip-existing: true
30
- print-hash: true
@@ -1,18 +0,0 @@
1
- # Python
2
- __pycache__/
3
- *.py[cod]
4
- *.egg-info/
5
- .dist/
6
- build/
7
- dist/
8
- .venv/
9
- .env
10
- .pytest_cache/
11
- .mypy_cache/
12
- .cache/
13
- .coverage
14
- htmlcov/
15
- .ruff_cache/
16
- # Editors
17
- .vscode/
18
- .idea/
@@ -1,4 +0,0 @@
1
- # Code of Conduct
2
-
3
- This project follows the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
4
- By participating in this project, you agree to uphold this code.
@@ -1,65 +0,0 @@
1
- # Contributing to wzrdbrain
2
-
3
- First off, thank you for considering contributing!
4
-
5
- ## Submitting Changes
6
-
7
- 1. Create a new branch for your feature or bug fix.
8
- 2. Make your changes and commit them.
9
- 3. Use clear, concise messages (e.g., feat: add X, fix: correct Y).
10
- 4. Ensure all quality checks pass.
11
- 5. Push your branch and open a pull request.
12
-
13
- ## Development Setup
14
-
15
- To get started with development, follow these steps:
16
-
17
- 1. **Clone the repository:**
18
- ```bash
19
- git clone <your-fork-url>
20
- cd wzrdbrain
21
- ```
22
-
23
- 2. **Create and activate a virtual environment:**
24
- ```bash
25
- python -m venv .venv
26
- source .venv/bin/activate # On Windows use: .venv\Scripts\activate
27
- ```
28
-
29
- 3. **Install the package in editable mode with development dependencies:**
30
- This command installs the project itself along with tools like `pytest`, `ruff`, and `mypy`.
31
- ```bash
32
- pip install -e ".[dev]"
33
- ```
34
-
35
- ## Running Quality Checks
36
-
37
- Before submitting a pull request, please ensure your code passes all quality checks.
38
-
39
- ### Linting and Formatting
40
-
41
- We use `ruff` for linting and `black` for formatting.
42
-
43
- ```bash
44
- # Check for linting errors
45
- ruff check .
46
-
47
- # Format the code
48
- black .
49
- ```
50
-
51
- ### Type Checking
52
-
53
- We use `mypy` for static type checking.
54
-
55
- ```bash
56
- mypy .
57
- ```
58
-
59
- ### Running Tests
60
-
61
- We use `pytest` for running unit tests.
62
-
63
- ```bash
64
- pytest
65
- ```
wzrdbrain-0.1.2/PKG-INFO DELETED
@@ -1,266 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: wzrdbrain
3
- Version: 0.1.2
4
- Summary: Basic APIs to generate tricks for wizard skating.
5
- Project-URL: Homepage, https://github.com/nazroll/wzrdbrain
6
- Project-URL: Documentation, https://github.com/nazroll/wzrdbrain#readme
7
- Project-URL: Repository, https://github.com/nazroll/wzrdbrain
8
- Project-URL: Issues, https://github.com/nazroll/wzrdbrain/issues
9
- Author: nazroll
10
- License: Apache License
11
- Version 2.0, January 2004
12
- http://www.apache.org/licenses/
13
-
14
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
15
-
16
- 1. Definitions.
17
-
18
- "License" shall mean the terms and conditions for use, reproduction,
19
- and distribution as defined by Sections 1 through 9 of this document.
20
-
21
- "Licensor" shall mean the copyright owner or entity authorized by
22
- the copyright owner that is granting the License.
23
-
24
- "Legal Entity" shall mean the union of the acting entity and all
25
- other entities that control, are controlled by, or are under common
26
- control with that entity. For the purposes of this definition,
27
- "control" means (i) the power, direct or indirect, to cause the
28
- direction or management of such entity, whether by contract or
29
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
30
- outstanding shares, or (iii) beneficial ownership of such entity.
31
-
32
- "You" (or "Your") shall mean an individual or Legal Entity
33
- exercising permissions granted by this License.
34
-
35
- "Source" form shall mean the preferred form for making modifications,
36
- including but not limited to software source code, documentation
37
- source, and configuration files.
38
-
39
- "Object" form shall mean any form resulting from mechanical
40
- transformation or translation of a Source form, including but
41
- not limited to compiled object code, generated documentation,
42
- and conversions to other media types.
43
-
44
- "Work" shall mean the work of authorship, whether in Source or
45
- Object form, made available under the License, as indicated by a
46
- copyright notice that is included in or attached to the work
47
- (an example is provided in the Appendix below).
48
-
49
- "Derivative Works" shall mean any work, whether in Source or Object
50
- form, that is based on (or derived from) the Work and for which the
51
- editorial revisions, annotations, elaborations, or other modifications
52
- represent, as a whole, an original work of authorship. For the purposes
53
- of this License, Derivative Works shall not include works that remain
54
- separable from, or merely link (or bind by name) to the interfaces of,
55
- the Work and Derivative Works thereof.
56
-
57
- "Contribution" shall mean any work of authorship, including
58
- the original version of the Work and any modifications or additions
59
- to that Work or Derivative Works thereof, that is intentionally
60
- submitted to Licensor for inclusion in the Work by the copyright owner
61
- or by an individual or Legal Entity authorized to submit on behalf of
62
- the copyright owner. For the purposes of this definition, "submitted"
63
- means any form of electronic, verbal, or written communication sent
64
- to the Licensor or its representatives, including but not limited to
65
- communication on electronic mailing lists, source code control systems,
66
- and issue tracking systems that are managed by, or on behalf of, the
67
- Licensor for the purpose of discussing and improving the Work, but
68
- excluding communication that is conspicuously marked or otherwise
69
- designated in writing by the copyright owner as "Not a Contribution."
70
-
71
- "Contributor" shall mean Licensor and any individual or Legal Entity
72
- on behalf of whom a Contribution has been received by Licensor and
73
- subsequently incorporated within the Work.
74
-
75
- 2. Grant of Copyright License. Subject to the terms and conditions of
76
- this License, each Contributor hereby grants to You a perpetual,
77
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
- copyright license to reproduce, prepare Derivative Works of,
79
- publicly display, publicly perform, sublicense, and distribute the
80
- Work and such Derivative Works in Source or Object form.
81
-
82
- 3. Grant of Patent License. Subject to the terms and conditions of
83
- this License, each Contributor hereby grants to You a perpetual,
84
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
85
- (except as stated in this section) patent license to make, have made,
86
- use, offer to sell, sell, import, and otherwise transfer the Work,
87
- where such license applies only to those patent claims licensable
88
- by such Contributor that are necessarily infringed by their
89
- Contribution(s) alone or by combination of their Contribution(s)
90
- with the Work to which such Contribution(s) was submitted. If You
91
- institute patent litigation against any entity (including a
92
- cross-claim or counterclaim in a lawsuit) alleging that the Work
93
- or a Contribution incorporated within the Work constitutes direct
94
- or contributory patent infringement, then any patent licenses
95
- granted to You under this License for that Work shall terminate
96
- as of the date such litigation is filed.
97
-
98
- 4. Redistribution. You may reproduce and distribute copies of the
99
- Work or Derivative Works thereof in any medium, with or without
100
- modifications, and in Source or Object form, provided that You
101
- meet the following conditions:
102
-
103
- (a) You must give any other recipients of the Work or
104
- Derivative Works a copy of this License; and
105
-
106
- (b) You must cause any modified files to carry prominent notices
107
- stating that You changed the files; and
108
-
109
- (c) You must retain, in the Source form of any Derivative Works
110
- that You distribute, all copyright, patent, trademark, and
111
- attribution notices from the Source form of the Work,
112
- excluding those notices that do not pertain to any part of
113
- the Derivative Works; and
114
-
115
- (d) If the Work includes a "NOTICE" text file as part of its
116
- distribution, then any Derivative Works that You distribute must
117
- include a readable copy of the attribution notices contained
118
- within such NOTICE file, excluding those notices that do not
119
- pertain to any part of the Derivative Works, in at least one
120
- of the following places: within a NOTICE text file distributed
121
- as part of the Derivative Works; within the Source form or
122
- documentation, if provided along with the Derivative Works; or,
123
- within a display generated by the Derivative Works, if and
124
- wherever such third-party notices normally appear. The contents
125
- of the NOTICE file are for informational purposes only and
126
- do not modify the License. You may add Your own attribution
127
- notices within Derivative Works that You distribute, alongside
128
- or as an addendum to the NOTICE text from the Work, provided
129
- that such additional attribution notices cannot be construed
130
- as modifying the License.
131
-
132
- You may add Your own copyright statement to Your modifications and
133
- may provide additional or different license terms and conditions
134
- for use, reproduction, or distribution of Your modifications, or
135
- for any such Derivative Works as a whole, provided Your use,
136
- reproduction, and distribution of the Work otherwise complies with
137
- the conditions stated in this License.
138
-
139
- 5. Submission of Contributions. Unless You explicitly state otherwise,
140
- any Contribution intentionally submitted for inclusion in the Work
141
- by You to the Licensor shall be under the terms and conditions of
142
- this License, without any additional terms or conditions.
143
- Notwithstanding the above, nothing herein shall supersede or modify
144
- the terms of any separate license agreement you may have executed
145
- with Licensor regarding such Contributions.
146
-
147
- 6. Trademarks. This License does not grant permission to use the trade
148
- names, trademarks, service marks, or product names of the Licensor,
149
- except as required for reasonable and customary use in describing the
150
- origin of the Work and reproducing the content of the NOTICE file.
151
-
152
- 7. Disclaimer of Warranty. Unless required by applicable law or
153
- agreed to in writing, Licensor provides the Work (and each
154
- Contributor provides its Contributions) on an "AS IS" BASIS,
155
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
156
- implied, including, without limitation, any warranties or conditions
157
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
158
- PARTICULAR PURPOSE. You are solely responsible for determining the
159
- appropriateness of using or redistributing the Work and assume any
160
- risks associated with Your exercise of permissions under this License.
161
-
162
- 8. Limitation of Liability. In no event and under no legal theory,
163
- whether in tort (including negligence), contract, or otherwise,
164
- unless required by applicable law (such as deliberate and grossly
165
- negligent acts) or agreed to in writing, shall any Contributor be
166
- liable to You for damages, including any direct, indirect, special,
167
- incidental, or consequential damages of any character arising as a
168
- result of this License or out of the use or inability to use the
169
- Work (including but not limited to damages for loss of goodwill,
170
- work stoppage, computer failure or malfunction, or any and all
171
- other commercial damages or losses), even if such Contributor
172
- has been advised of the possibility of such damages.
173
-
174
- 9. Accepting Warranty or Additional Liability. While redistributing
175
- the Work or Derivative Works thereof, You may choose to offer,
176
- and charge a fee for, acceptance of support, warranty, indemnity,
177
- or other liability obligations and/or rights consistent with this
178
- License. However, in accepting such obligations, You may act only
179
- on Your own behalf and on Your sole responsibility, not on behalf
180
- of any other Contributor, and only if You agree to indemnify,
181
- defend, and hold each Contributor harmless for any liability
182
- incurred by, or claims asserted against, such Contributor by reason
183
- of your accepting any such warranty or additional liability.
184
-
185
- END OF TERMS AND CONDITIONS
186
-
187
- APPENDIX: How to apply the Apache License to your work.
188
-
189
- To apply the Apache License to your work, attach the following
190
- boilerplate notice, with the fields enclosed by brackets "[]"
191
- replaced with your own identifying information. (Don't include
192
- the brackets!) The text should be enclosed in the appropriate
193
- comment syntax for the file format. We also recommend that a
194
- file or class name and description of purpose be included on the
195
- same "printed page" as the copyright notice for easier
196
- identification within third-party archives.
197
-
198
- Copyright [2025] [Nazrul Kamaruddin]
199
-
200
- Licensed under the Apache License, Version 2.0 (the "License");
201
- you may not use this file except in compliance with the License.
202
- You may obtain a copy of the License at
203
-
204
- http://www.apache.org/licenses/LICENSE-2.0
205
-
206
- Unless required by applicable law or agreed to in writing, software
207
- distributed under the License is distributed on an "AS IS" BASIS,
208
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
209
- See the License for the specific language governing permissions and
210
- limitations under the License.
211
- License-File: LICENSE
212
- Keywords: generator,inline skating,random,tricks,wizard skating
213
- Classifier: Development Status :: 3 - Alpha
214
- Classifier: Intended Audience :: Developers
215
- Classifier: License :: OSI Approved :: MIT License
216
- Classifier: Programming Language :: Python
217
- Classifier: Programming Language :: Python :: 3
218
- Classifier: Programming Language :: Python :: 3 :: Only
219
- Classifier: Programming Language :: Python :: 3.9
220
- Classifier: Programming Language :: Python :: 3.10
221
- Classifier: Programming Language :: Python :: 3.11
222
- Classifier: Programming Language :: Python :: 3.12
223
- Classifier: Programming Language :: Python :: 3.13
224
- Classifier: Topic :: Games/Entertainment
225
- Classifier: Topic :: Software Development :: Libraries
226
- Classifier: Typing :: Typed
227
- Requires-Python: >=3.9
228
- Provides-Extra: dev
229
- Requires-Dist: black>=24.3; extra == 'dev'
230
- Requires-Dist: build>=1.2; extra == 'dev'
231
- Requires-Dist: mypy>=1.10; extra == 'dev'
232
- Requires-Dist: pytest>=8; extra == 'dev'
233
- Requires-Dist: ruff>=0.5; extra == 'dev'
234
- Description-Content-Type: text/markdown
235
-
236
- # wzrdbrain
237
-
238
- A simple library to generate random trick combinations for wizard skating.
239
-
240
- ## Installation
241
-
242
- ```bash
243
- pip install wzrdbrain
244
- ```
245
-
246
- ## Usage
247
-
248
- ```python
249
- from wzrdbrain import generate_trick, generate_combo
250
-
251
- # Generate a single trick as a list of its parts
252
- print(generate_trick())
253
- # Example output: ['front', 'open', 'lion']
254
-
255
- # Generate a line of multiple tricks as formatted strings
256
- print(generate_combo(3))
257
- # Example output: ['front parallel', 'fakie toe press', 'forward 360']
258
- ```
259
-
260
- ## List of wizard skating tricks
261
-
262
- The list of tricks in this library is not comprehensive. Please create an issue and give us your suggestions of new tricks to be added.
263
-
264
- ## Contributing
265
-
266
- Contributions are welcome! Please see the [Contributing Guide](CONTRIBUTING.md) for details on how to set up your development environment, run tests, and submit changes.
wzrdbrain-0.1.2/README.md DELETED
@@ -1,31 +0,0 @@
1
- # wzrdbrain
2
-
3
- A simple library to generate random trick combinations for wizard skating.
4
-
5
- ## Installation
6
-
7
- ```bash
8
- pip install wzrdbrain
9
- ```
10
-
11
- ## Usage
12
-
13
- ```python
14
- from wzrdbrain import generate_trick, generate_combo
15
-
16
- # Generate a single trick as a list of its parts
17
- print(generate_trick())
18
- # Example output: ['front', 'open', 'lion']
19
-
20
- # Generate a line of multiple tricks as formatted strings
21
- print(generate_combo(3))
22
- # Example output: ['front parallel', 'fakie toe press', 'forward 360']
23
- ```
24
-
25
- ## List of wizard skating tricks
26
-
27
- The list of tricks in this library is not comprehensive. Please create an issue and give us your suggestions of new tricks to be added.
28
-
29
- ## Contributing
30
-
31
- Contributions are welcome! Please see the [Contributing Guide](CONTRIBUTING.md) for details on how to set up your development environment, run tests, and submit changes.
@@ -1,10 +0,0 @@
1
- from .wzrdbrain import generate_combo, generate_trick
2
-
3
- """
4
- wzrdbrain: Basic APIs to generate tricks for wizard skating.
5
- """
6
-
7
-
8
- __all__ = ["generate_trick", "generate_combo"]
9
-
10
- __version__ = "0.1.0"
@@ -1,93 +0,0 @@
1
- import random
2
- from typing import Optional
3
-
4
- # Trick data definitions
5
- direction = ["front", "back"]
6
- stance = ["open", "closed"]
7
- move = [
8
- "predator",
9
- "predator one",
10
- "parallel",
11
- "tree",
12
- "gazelle",
13
- "gazelle s",
14
- "lion",
15
- "lion s",
16
- "toe press",
17
- "heel press",
18
- "toe roll",
19
- "heel roll",
20
- "360",
21
- "180",
22
- "parallel slide",
23
- "soul slide",
24
- "acid slide",
25
- "mizu slide",
26
- "star slide",
27
- "fast slide",
28
- "back slide",
29
- ]
30
- exclude_stance = [
31
- "predator",
32
- "predator one",
33
- "toe press",
34
- "toe roll",
35
- "heel press",
36
- "heel roll",
37
- "360",
38
- "180",
39
- "parallel slide",
40
- "soul slide",
41
- "acid slide",
42
- "mizu slide",
43
- "star slide",
44
- "fast slide",
45
- "back slide",
46
- ]
47
- use_fakie = [
48
- "toe press",
49
- "toe roll",
50
- "heel press",
51
- "heel roll",
52
- "360",
53
- "180",
54
- "parallel slide",
55
- "soul slide",
56
- "acid slide",
57
- "mizu slide",
58
- "star slide",
59
- "fast slide",
60
- "back slide",
61
- ]
62
-
63
-
64
- # Generate a trick
65
- def generate_trick() -> list[str]:
66
- selected_move = random.choice(move)
67
- trick = [random.choice(direction)]
68
-
69
- if selected_move not in exclude_stance:
70
- trick.append(random.choice(stance))
71
-
72
- trick.append(selected_move)
73
- return trick
74
-
75
-
76
- # Generate a combination of tricks. Default setting is random, between 1-5 tricks.
77
- def generate_combo(num_of_tricks: Optional[int] = None) -> list[str]:
78
- if num_of_tricks is None:
79
- num_of_tricks = random.randint(1, 5)
80
-
81
- trick_line: list[str] = []
82
- for i in range(num_of_tricks):
83
- trick_parts = generate_trick()
84
- # If the move uses the fakie semantics, convert the direction "front"/"back" to "forward"/"fakie"
85
- if trick_parts:
86
- move_name = trick_parts[-1]
87
- if move_name in use_fakie:
88
- if trick_parts[0] == "back":
89
- trick_parts[0] = "fakie"
90
- elif trick_parts[0] == "front":
91
- trick_parts[0] = "forward"
92
- trick_line.append(" ".join(trick_parts))
93
- return trick_line
@@ -1,75 +0,0 @@
1
- from pathlib import Path
2
- import sys
3
- from collections.abc import Iterator, Sequence
4
-
5
- import pytest
6
-
7
- # Ensure src is on path so we can import the module under test
8
- ROOT = Path(__file__).resolve().parents[1]
9
- SRC = ROOT / "src"
10
- sys.path.insert(0, str(SRC))
11
-
12
- import wzrdbrain.wzrdbrain as wb # noqa: E402
13
-
14
-
15
- def test_generate_trick_exclude_stance(monkeypatch: pytest.MonkeyPatch) -> None:
16
- # Force choices so selected_move is in exclude_stance ('predator')
17
- def fake_choice(seq: Sequence[str]) -> str:
18
- if seq is wb.move:
19
- return "predator"
20
- if seq is wb.direction:
21
- return "front"
22
- if seq is wb.stance:
23
- return "open"
24
- raise RuntimeError("unexpected seq")
25
-
26
- # patch the module-level random.choice by target string to avoid mypy attr warnings
27
- monkeypatch.setattr("wzrdbrain.wzrdbrain.random.choice", fake_choice)
28
- trick = wb.generate_trick()
29
- assert trick == ["front", "predator"]
30
-
31
-
32
- def test_generate_trick_with_stance(monkeypatch: pytest.MonkeyPatch) -> None:
33
- # Force choices so selected_move is NOT in exclude_stance ('parallel')
34
- def fake_choice(seq: Sequence[str]) -> str:
35
- if seq is wb.move:
36
- return "parallel"
37
- if seq is wb.direction:
38
- return "back"
39
- if seq is wb.stance:
40
- return "open"
41
- raise RuntimeError("unexpected seq")
42
-
43
- monkeypatch.setattr("wzrdbrain.wzrdbrain.random.choice", fake_choice)
44
- trick = wb.generate_trick()
45
- assert trick == ["back", "open", "parallel"]
46
-
47
-
48
- def test_generate_combo_fakie_conversion(monkeypatch: pytest.MonkeyPatch) -> None:
49
- # Provide deterministic successive generate_trick outputs to test fakie/forward conversion
50
- seq: Iterator[list[str]] = iter(
51
- [
52
- ["front", "parallel"], # not in use_fakie -> unchanged
53
- ["back", "toe press"], # in use_fakie -> back -> fakie (since it's subsequent)
54
- ["front", "360"], # in use_fakie -> front -> forward
55
- ]
56
- )
57
-
58
- def fake_generate_trick() -> list[str]:
59
- return next(seq)
60
-
61
- monkeypatch.setattr(wb, "generate_trick", fake_generate_trick)
62
- line = wb.generate_combo(3)
63
- assert line == [
64
- "front parallel",
65
- "fakie toe press",
66
- "forward 360",
67
- ]
68
-
69
-
70
- def test_generate_combo_default_length() -> None:
71
- # Default should produce between 1 and 5 tricks
72
- line = wb.generate_combo()
73
- assert 1 <= len(line) <= 5
74
- for item in line:
75
- assert isinstance(item, str)
File without changes