wzrdbrain 0.1.0__tar.gz → 0.1.1__tar.gz

wzrdbrain-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing to wzrdbrain
+
+First off, thank you for considering contributing!
+
+## Submitting Changes
+
+1.  Create a new branch for your feature or bug fix.
+2.  Make your changes and commit them.
+3.  Use clear, concise messages (e.g., feat: add X, fix: correct Y).
+4.  Ensure all quality checks pass.
+5.  Push your branch and open a pull request.
+
+## Development Setup
+
+To get started with development, follow these steps:
+
+1.  **Clone the repository:**
+    ```bash
+    git clone <your-fork-url>
+    cd wzrdbrain
+    ```
+
+2.  **Create and activate a virtual environment:**
+    ```bash
+    python -m venv .venv
+    source .venv/bin/activate  # On Windows use: .venv\Scripts\activate
+    ```
+
+3.  **Install the package in editable mode with development dependencies:**
+    This command installs the project itself along with tools like `pytest`, `ruff`, and `mypy`.
+    ```bash
+    pip install -e ".[dev]"
+    ```
+
+## Running Quality Checks
+
+Before submitting a pull request, please ensure your code passes all quality checks.
+
+### Linting and Formatting
+
+We use `ruff` for linting and `black` for formatting.
+
+```bash
+# Check for linting errors
+ruff check .
+
+# Format the code
+black .
+```
+
+### Type Checking
+
+We use `mypy` for static type checking.
+
+```bash
+mypy .
+```
+
+### Running Tests
+
+We use `pytest` for running unit tests.
+
+```bash
+pytest
+```

{wzrdbrain-0.1.0 → wzrdbrain-0.1.1}/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,31 @@
+# wzrdbrain
+
+A simple library to generate random trick combinations for wizard skating.
+
+## Installation
+
+```bash
+pip install wzrdbrain
+```
+
+## Usage
+
+```python
+from wzrdbrain import generate_trick, generate_combo
+
+# Generate a single trick as a list of its parts
+print(generate_trick())
+# Example output: ['front', 'open', 'lion']
+
+# Generate a line of multiple tricks as formatted strings
+print(generate_combo(3))
+# Example output: ['front parallel', 'fakie toe press', 'forward 360']
+```
+
+## List of wizard skating tricks
+
+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.
+
+## Contributing
+
+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.0 → wzrdbrain-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "wzrdbrain"
-version = "0.1.0"
+version = "0.1.1"
 description = "Basic APIs to generate tricks for wizard skating."
 readme = "README.md"
 requires-python = ">=3.9"

wzrdbrain-0.1.0/CONTRIBUTING.md

@@ -1,21 +0,0 @@
-# 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/README.md

@@ -1,52 +0,0 @@
-# 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.