wzrdbrain 0.1.0__tar.gz → 0.1.2__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,65 @@
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
+ ```
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [2025] [Nazrul Kamaruddin]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,266 @@
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.
@@ -0,0 +1,31 @@
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.
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "wzrdbrain"
7
- version = "0.1.0"
7
+ version = "0.1.2"
8
8
  description = "Basic APIs to generate tricks for wizard skating."
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.9"
@@ -62,4 +62,4 @@ addopts = "-q"
62
62
 
63
63
  [tool.mypy]
64
64
  strict = true
65
- warn_unused_ignores = true
65
+ warn_unused_ignores = true
@@ -1,21 +0,0 @@
1
- # Contributing
2
-
3
- Thanks for your interest in contributing to wzrdbrain!
4
-
5
- - Discuss major changes in an issue before opening a PR.
6
- - Keep the public API minimal, well-documented, and typed.
7
- - Run `ruff`, `black`, `mypy`, and `pytest` locally before pushing.
8
- - Add or update tests for behavior changes.
9
-
10
- ## Dev setup
11
-
12
- ```bash
13
- python -m venv .venv
14
- source .venv/bin/activate
15
- pip install -e ".[dev]"
16
- ```
17
-
18
- ## Commit style
19
-
20
- - Use clear, concise messages (e.g., `feat: add X`, `fix: correct Y`).
21
- - Prefer small, focused PRs.
wzrdbrain-0.1.0/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2025 Nazrul Kamaruddin
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.
wzrdbrain-0.1.0/PKG-INFO DELETED
@@ -1,107 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: wzrdbrain
3
- Version: 0.1.0
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: MIT License
11
-
12
- Copyright (c) 2025 Nazrul Kamaruddin
13
-
14
- Permission is hereby granted, free of charge, to any person obtaining a copy
15
- of this software and associated documentation files (the "Software"), to deal
16
- in the Software without restriction, including without limitation the rights
17
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18
- copies of the Software, and to permit persons to whom the Software is
19
- furnished to do so, subject to the following conditions:
20
-
21
- The above copyright notice and this permission notice shall be included in
22
- all copies or substantial portions of the Software.
23
-
24
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
29
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
30
- THE SOFTWARE.
31
- License-File: LICENSE
32
- Keywords: generator,inline skating,random,tricks,wizard skating
33
- Classifier: Development Status :: 3 - Alpha
34
- Classifier: Intended Audience :: Developers
35
- Classifier: License :: OSI Approved :: MIT License
36
- Classifier: Programming Language :: Python
37
- Classifier: Programming Language :: Python :: 3
38
- Classifier: Programming Language :: Python :: 3 :: Only
39
- Classifier: Programming Language :: Python :: 3.9
40
- Classifier: Programming Language :: Python :: 3.10
41
- Classifier: Programming Language :: Python :: 3.11
42
- Classifier: Programming Language :: Python :: 3.12
43
- Classifier: Programming Language :: Python :: 3.13
44
- Classifier: Topic :: Games/Entertainment
45
- Classifier: Topic :: Software Development :: Libraries
46
- Classifier: Typing :: Typed
47
- Requires-Python: >=3.9
48
- Provides-Extra: dev
49
- Requires-Dist: black>=24.3; extra == 'dev'
50
- Requires-Dist: build>=1.2; extra == 'dev'
51
- Requires-Dist: mypy>=1.10; extra == 'dev'
52
- Requires-Dist: pytest>=8; extra == 'dev'
53
- Requires-Dist: ruff>=0.5; extra == 'dev'
54
- Description-Content-Type: text/markdown
55
-
56
- # wzrdbrain
57
-
58
- Basic APIs to generate tricks for wizard skating.
59
-
60
- ## Installation
61
-
62
- ```bash
63
- pip install wzrdbrain
64
- ```
65
-
66
- ## Usage
67
-
68
- ```python
69
- from wzrdbrain import generate_trick, generate_tricks
70
-
71
- # Single trick (random)
72
- print(generate_trick()) # e.g., "Front Open Lion"
73
-
74
- # Multiple tricks
75
- print(generate_combo(5)) # Maximum of 5 tricks in a combo (duplicates allowed)
76
- ```
77
-
78
- ## Development
79
-
80
- ```bash
81
- # clone your repo
82
- python -m venv .venv
83
- source .venv/bin/activate # on Windows: .venv\Scripts\activate
84
- pip install -e ".[dev]"
85
-
86
- # lint + format
87
- ruff check .
88
- black .
89
-
90
- # type-check
91
- mypy .
92
-
93
- # tests
94
- pytest
95
- ```
96
-
97
- ## Release
98
-
99
- 1. Update version in `pyproject.toml` and `src/wzrdbrain/__init__.py`.
100
- 2. Create a Git tag and GitHub Release, e.g. `v0.1.0`.
101
- 3. The release workflow will build and publish to PyPI via Trusted Publishing.
102
-
103
- ## Notes
104
-
105
- - Reproducibility: Set `seed` to get the same result across runs.
106
- - Categories: Use `categories()` to see available groups and restrict generation.
107
- - Typing: This library ships `py.typed` for type checkers.
wzrdbrain-0.1.0/README.md DELETED
@@ -1,52 +0,0 @@
1
- # wzrdbrain
2
-
3
- Basic APIs to generate tricks 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_tricks
15
-
16
- # Single trick (random)
17
- print(generate_trick()) # e.g., "Front Open Lion"
18
-
19
- # Multiple tricks
20
- print(generate_combo(5)) # Maximum of 5 tricks in a combo (duplicates allowed)
21
- ```
22
-
23
- ## Development
24
-
25
- ```bash
26
- # clone your repo
27
- python -m venv .venv
28
- source .venv/bin/activate # on Windows: .venv\Scripts\activate
29
- pip install -e ".[dev]"
30
-
31
- # lint + format
32
- ruff check .
33
- black .
34
-
35
- # type-check
36
- mypy .
37
-
38
- # tests
39
- pytest
40
- ```
41
-
42
- ## Release
43
-
44
- 1. Update version in `pyproject.toml` and `src/wzrdbrain/__init__.py`.
45
- 2. Create a Git tag and GitHub Release, e.g. `v0.1.0`.
46
- 3. The release workflow will build and publish to PyPI via Trusted Publishing.
47
-
48
- ## Notes
49
-
50
- - Reproducibility: Set `seed` to get the same result across runs.
51
- - Categories: Use `categories()` to see available groups and restrict generation.
52
- - Typing: This library ships `py.typed` for type checkers.
File without changes
File without changes