gale-shapley-algorithm 1.1.2__tar.gz

gale_shapley_algorithm-1.1.2/.claude/skills/commit/SKILL.md

@@ -0,0 +1,36 @@
+---
+name: commit
+description: Create well-structured git commits following conventional commit format. Use when the user asks to commit changes, create a commit, or save their work to git.
+---
+# Commit Skill
+
+Create commits following the project's conventional commit format.
+
+## Commit Format
+
+```
+<type>[(scope)]: Subject
+```
+
+**Types:** `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `deps`
+
+**Changelog types:** `build`, `deps`, `feat`, `fix`, `refactor`
+
+## Process
+
+1. Run `git status` to see changes
+2. Run `git diff --staged` and `git diff` to understand changes
+3. Analyze all changes and draft commit message:
+   - Summarize the nature (feat, fix, refactor, etc.)
+   - Focus on "why" rather than "what"
+   - Keep subject under 72 characters
+4. Stage specific files (avoid `git add -A`)
+5. Create commit with conventional format
+6. Verify with `git status`
+
+## Guidelines
+
+- Never commit sensitive files (.env, credentials)
+- Stage specific files rather than using `git add -A`
+- One logical change per commit
+- Subject should complete: "If applied, this commit will..."

gale_shapley_algorithm-1.1.2/.claude/skills/fix/SKILL.md

@@ -0,0 +1,55 @@
+---
+name: fix
+description: Run code formatting and linting with auto-fix using ruff via taskipy. Use when the user asks to fix code style, format code, lint, or clean up their code.
+---
+# Fix Skill
+
+Auto-format and lint code using ruff via taskipy.
+
+## Commands
+
+```bash
+# Format + lint with auto-fix (recommended)
+uvx --from taskipy task fix
+
+# Format only
+uvx --from taskipy task format
+
+# Lint with auto-fix only
+uvx --from taskipy task lint
+
+# Check formatting without changes (CI mode)
+uvx --from taskipy task format_check
+
+# Check linting without changes (CI mode)
+uvx --from taskipy task lint_check
+```
+
+## What Gets Fixed
+
+**Formatting (ruff format):**
+- Consistent indentation
+- Line length (120 chars max)
+- Quote style normalization
+- Trailing whitespace
+
+**Linting (ruff check --fix):**
+- Import sorting and organization
+- Unused imports removal
+- Simple code improvements
+- PEP 8 compliance
+
+## Process
+
+1. Run `uvx --from taskipy task fix`
+2. Review any remaining issues that couldn't be auto-fixed
+3. Manually address unfixable issues
+4. Run again to verify clean output
+
+## Configuration
+
+Ruff configuration is in `config/ruff.toml`:
+- Line length: 120
+- Target Python version matches project
+- Google-style docstrings
+- Absolute imports only

gale_shapley_algorithm-1.1.2/.claude/skills/pr/SKILL.md

@@ -0,0 +1,49 @@
+---
+name: pr
+description: Create GitHub pull requests with proper formatting and descriptions. Use when the user asks to create a PR, open a pull request, or submit their changes for review.
+---
+# Pull Request Skill
+
+Create well-structured GitHub pull requests.
+
+## Process
+
+1. Check current branch state:
+   - `git status` for uncommitted changes
+   - `git log origin/main..HEAD` for commits to include
+   - `git diff main...HEAD` for full diff
+2. Analyze ALL commits (not just the latest)
+3. Draft PR title and description:
+   - Title: Under 70 characters, descriptive
+   - Summary: 1-3 bullet points
+   - Test plan: How to verify changes
+4. Push branch and create PR
+
+## PR Format
+
+```markdown
+## Summary
+- Bullet point describing main change
+- Additional changes if applicable
+
+## Test plan
+- [ ] How to test the changes
+- [ ] Expected outcomes
+```
+
+## Commands
+
+```bash
+# Push branch
+git push -u origin <branch-name>
+
+# Create PR
+gh pr create --title "Title" --body "Body"
+```
+
+## Guidelines
+
+- Keep PR title short and descriptive
+- Reference related issues with #number
+- Include test plan for reviewers
+- One logical change per PR when possible

gale_shapley_algorithm-1.1.2/.claude/skills/release/SKILL.md

@@ -0,0 +1,41 @@
+---
+name: release
+description: Perform a project release by updating the changelog, bumping the version, committing, tagging, and pushing. Use when the user asks to release, cut a release, bump the version, or publish a new version.
+---
+# Release Skill
+
+Perform a full release for this project.
+
+## Process
+
+1. Ensure you are on `main` and up to date:
+   ```bash
+   git checkout main
+   git pull
+   ```
+2. Run the changelog task to auto-determine the next version:
+   ```bash
+   uvx --from taskipy task changelog
+   ```
+3. Read `CHANGELOG.md` and extract the new version number from the latest heading.
+4. Present the changelog diff to the user for review. **Wait for user approval before continuing.**
+5. Update `__version__` in `src/gale_shapley/__init__.py` to match the new version (without the `v` prefix).
+6. Stage and commit:
+   ```bash
+   git add CHANGELOG.md src/gale_shapley/__init__.py
+   git commit -m "chore: Release version X.Y.Z"
+   ```
+7. Push, tag, and push the tag:
+   ```bash
+   git push
+   git tag vX.Y.Z
+   git push --tags
+   ```
+8. The GitHub Actions release workflow will automatically create a GitHub release from the tag.
+
+## Important
+
+- **Always wait for user approval** after showing the changelog diff before committing.
+- The version in `__init__.py` must match the tag without the `v` prefix (e.g., `__version__ = "1.2.0"` and tag `v1.2.0`).
+- Only changelog-relevant commit types appear: `build`, `deps`, `feat`, `fix`, `refactor`.
+- If there are no releasable commits since the last tag, inform the user and stop.

gale_shapley_algorithm-1.1.2/.claude/skills/review/SKILL.md

@@ -0,0 +1,72 @@
+---
+name: review
+description: Review code for issues, best practices, and improvements. Use when the user asks for a code review, wants feedback on their code, or asks you to check their implementation.
+---
+# Review Skill
+
+Perform code review focusing on quality, correctness, and maintainability.
+
+## Review Checklist
+
+### Correctness
+- Logic errors or edge cases
+- Error handling coverage
+- Type safety and null checks
+
+### Code Quality (SOLID + Clean Code)
+- **Single Responsibility**: One reason to change per class/function
+- **Open/Closed**: Open for extension, closed for modification
+- **Liskov Substitution**: Subtypes substitutable for base types
+- **Interface Segregation**: Specific interfaces over general ones
+- **Dependency Inversion**: Depend on abstractions
+- DRY, YAGNI, meaningful names, Boy Scout Rule
+- Functions: Small (<20 lines), do one thing, few args (0-2)
+- No side effects, appropriate abstraction level
+
+### Style Compliance
+- Type hints on all functions/methods
+- Google-style docstrings
+- Absolute imports only
+- Line length under 120 chars
+
+### Testing
+- Tests cover new functionality
+- Tests verify behavior, not implementation
+- Edge cases tested
+- No flaky tests
+
+### Security
+- No hardcoded secrets
+- Input validation at boundaries
+- Safe handling of user data
+
+## Process
+
+1. Read the code to understand its purpose
+2. Run through the review checklist
+3. Identify issues by category:
+   - **Critical**: Bugs, security issues
+   - **Major**: Design problems, missing tests
+   - **Minor**: Style, naming, documentation
+4. Provide actionable feedback with specific suggestions
+5. Note positive aspects of the code
+
+## Output Format
+
+```markdown
+## Code Review
+
+### Summary
+Brief overview of the code's purpose and quality.
+
+### Critical Issues
+- Issue description and location
+- Suggested fix
+
+### Suggestions
+- Improvement opportunities
+- Alternative approaches
+
+### Positive Notes
+- Well-done aspects
+```

gale_shapley_algorithm-1.1.2/.claude/skills/test/SKILL.md

@@ -0,0 +1,58 @@
+---
+name: test
+description: Run the project test suite using taskipy. Use when the user asks to run tests, check if tests pass, verify their changes, or test specific functionality.
+---
+# Test Skill
+
+Run the project's test suite with pytest via taskipy.
+
+## Commands
+
+```bash
+# Run full test suite with coverage
+uvx --from taskipy task test
+
+# Run tests without coverage (faster)
+uvx --from taskipy task test_no_cov
+
+# Run specific test file
+uv run pytest tests/test_specific.py
+
+# Run specific test function
+uv run pytest tests/test_file.py::test_function
+
+# Run tests matching pattern
+uv run pytest -k "pattern"
+
+# Run with verbose output
+uv run pytest -v
+```
+
+## Process
+
+1. Run the appropriate test command
+2. Analyze test output for failures
+3. If failures occur:
+   - Identify the failing test(s)
+   - Read the test code to understand expectations
+   - Fix the issue in the source code
+   - Re-run to verify the fix
+
+## Coverage
+
+Test coverage reports are generated automatically with `task test`. The project maintains coverage thresholds defined in `config/pytest.ini`.
+
+## TDD (Test-Driven Development)
+
+**Three Laws:** (1) No production code without a failing test. (2) Write only enough test to fail. (3) Write only enough code to pass.
+
+**Cycle:** Red -> Green -> Refactor -> Repeat
+
+**FIRST:** **F**ast, **I**ndependent, **R**epeatable, **S**elf-validating, **T**imely
+
+## Guidelines
+
+- Test behavior, not implementation
+- Run tests after making changes
+- Write tests for new functionality
+- Use fixtures for common setup

gale_shapley_algorithm-1.1.2/.dockerignore

@@ -0,0 +1,20 @@
+.git
+.github
+.venv
+.claude
+.cursor
+__pycache__
+*.pyc
+.pytest_cache
+.ruff_cache
+htmlcov
+site
+docs
+tests
+logs
+frontend/node_modules
+.pre-commit-config.yaml
+.gitignore
+LICENSE
+*.md
+!README.md

gale_shapley_algorithm-1.1.2/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: unconfirmed
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Run command '...'
+3. Scroll down to '...'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System (please complete the following information):**
+- Python version: [e.g. 3.9]
+- OS: [Ubuntu/MacOS/Windows]
+
+**Additional context**
+Add any other context about the problem here.

gale_shapley_algorithm-1.1.2/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

gale_shapley_algorithm-1.1.2/.github/workflows/ci.yml

@@ -0,0 +1,102 @@
+name: ci
+
+on:
+  push:
+    branches:
+    - main
+    - test-me-*
+  pull_request:
+    branches:
+    - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  LANG: en_US.utf-8
+  LC_ALL: en_US.utf-8
+  PYTHONIOENCODING: UTF-8
+  PYTHONWARNDEFAULTENCODING: "1"
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+        fetch-tags: true
+
+    - name: Setup Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.13"
+
+    - name: Setup uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+        cache-dependency-glob: pyproject.toml
+
+    - name: Install dependencies
+      run: uvx --from taskipy task setup
+
+    - name: Check code formatting
+      run: uvx --from taskipy task format_check
+
+    - name: Check code quality (lint)
+      run: uvx --from taskipy task lint_check
+
+    - name: Build documentation
+      run: uvx --from taskipy task docs_build
+
+    - name: Store objects inventory for tests
+      uses: actions/upload-artifact@v5
+      with:
+        name: objects.inv
+        path: site/objects.inv
+
+  test:
+    needs: quality
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.12", "3.13"]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+        fetch-tags: true
+
+    - name: Setup Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Setup uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+        cache-dependency-glob: pyproject.toml
+
+    - name: Install dependencies
+      run: uv sync --extra cli --extra gui --python ${{ matrix.python-version }}
+
+    - name: Download objects inventory
+      uses: actions/download-artifact@v6
+      with:
+        name: objects.inv
+        path: site/
+
+    - name: Run tests
+      run: uv run --python ${{ matrix.python-version }} pytest -c config/pytest.ini

gale_shapley_algorithm-1.1.2/.github/workflows/docs.yml

@@ -0,0 +1,64 @@
+name: docs
+
+on:
+  push:
+    branches:
+    - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: docs
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+        fetch-tags: true
+
+    - name: Setup Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.13"
+
+    - name: Setup uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+        cache-dependency-glob: pyproject.toml
+
+    - name: Install dependencies
+      run: uvx --from taskipy task setup
+
+    - name: Build documentation
+      run: uvx --from taskipy task docs_build
+
+    - name: Upload pages artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: site/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

gale_shapley_algorithm-1.1.2/.github/workflows/publish.yml

@@ -0,0 +1,47 @@
+name: publish
+
+on:
+  release:
+    types: [created]
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  LANG: en_US.utf-8
+  LC_ALL: en_US.utf-8
+  PYTHONIOENCODING: UTF-8
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    environment: pypi
+
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+        fetch-tags: true
+
+    - name: Setup Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.13"
+
+    - name: Setup uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+        cache-dependency-glob: pyproject.toml
+
+    - name: Build package
+      run: uv build
+
+    - name: Publish to PyPI
+      run: uv publish --trusted-publishing always