wzrdbrain 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

{wzrdbrain-0.1.0.dist-info → wzrdbrain-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wzrdbrain
-Version: 0.1.0
+Version: 0.1.1
 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
@@ -55,7 +55,7 @@ Description-Content-Type: text/markdown
 
 # wzrdbrain
 
-Basic APIs to generate tricks for wizard skating.
+A simple library to generate random trick combinations for wizard skating.
 
 ## Installation
 
@@ -66,42 +66,21 @@ pip install wzrdbrain
 ## Usage
 
 ```python
-from wzrdbrain import generate_trick, generate_tricks
+from wzrdbrain import generate_trick, generate_combo
 
-# Single trick (random)
-print(generate_trick())  # e.g., "Front Open Lion"
+# Generate a single trick as a list of its parts
+print(generate_trick())
+# Example output: ['front', 'open', 'lion']
 
-# Multiple tricks
-print(generate_combo(5))  # Maximum of 5 tricks in a combo (duplicates allowed)
+# Generate a line of multiple tricks as formatted strings
+print(generate_combo(3))
+# Example output: ['front parallel', 'fakie toe press', 'forward 360']
 ```
 
-## Development
+## List of wizard skating tricks
 
-```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.
+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.
 
-## Notes
+## Contributing
 
-- 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.
+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.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+wzrdbrain/__init__.py,sha256=trIv6PSyva-qbi3Qjyzu7PAvkZoFT33709p47wHFXFg,196
+wzrdbrain/wzrdbrain.py,sha256=VeVdgaGD62kRz8qv3vFlpNMKd87X6di4oWXVAJxujP4,2067
+wzrdbrain-0.1.1.dist-info/METADATA,sha256=RTo1aEX_6mDE00WS3DdOm4oATH8zgTViMubW_VLUpiU,3523
+wzrdbrain-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+wzrdbrain-0.1.1.dist-info/licenses/LICENSE,sha256=Hy5x7SjmbSRYLupIQI0bKAlfdZadCRV6Ka3XCXQrbAo,1073
+wzrdbrain-0.1.1.dist-info/RECORD,,

wzrdbrain-0.1.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-wzrdbrain/__init__.py,sha256=trIv6PSyva-qbi3Qjyzu7PAvkZoFT33709p47wHFXFg,196
-wzrdbrain/wzrdbrain.py,sha256=VeVdgaGD62kRz8qv3vFlpNMKd87X6di4oWXVAJxujP4,2067
-wzrdbrain-0.1.0.dist-info/METADATA,sha256=nrpSLlJHxEuaVHAe-AfMOaBZG6JNahsZz_NR9HQdAeU,3708
-wzrdbrain-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-wzrdbrain-0.1.0.dist-info/licenses/LICENSE,sha256=Hy5x7SjmbSRYLupIQI0bKAlfdZadCRV6Ka3XCXQrbAo,1073
-wzrdbrain-0.1.0.dist-info/RECORD,,