fastapi-refine 0.1.0__tar.gz

fastapi_refine-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,42 @@
+---
+name: Bug Report
+about: Report a bug or unexpected behavior
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+## Bug Description
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior:
+1. Setup code: '...'
+2. Run code: '...'
+3. Observe error: '...'
+
+## Expected Behavior
+A clear and concise description of what you expected to happen.
+
+## Actual Behavior
+What actually happened.
+
+## Minimal Reproducible Example
+```python
+# Please provide a minimal code example that reproduces the issue
+```
+
+## Environment
+- Python version: [e.g., 3.11]
+- fastapi-refine version: [e.g., 0.1.0]
+- FastAPI version: [e.g., 0.114.2]
+- SQLModel version: [e.g., 0.0.21]
+- OS: [e.g., Ubuntu 22.04]
+
+## Error Messages
+```
+Paste any error messages or stack traces here
+```
+
+## Additional Context
+Add any other context about the problem here.

fastapi_refine-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,29 @@
+---
+name: Feature Request
+about: Suggest an idea or new feature
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+## Is your feature request related to a problem?
+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.
+
+## Example Usage
+```python
+# Show how you'd like to use this feature
+```
+
+## 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, screenshots, or examples about the feature request here.
+
+## Would you be willing to contribute this feature?
+- [ ] Yes, I can work on this
+- [ ] No, but I can help test it
+- [ ] No, just requesting

fastapi_refine-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,41 @@
+## Description
+<!-- Provide a brief description of the changes -->
+
+## Type of Change
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Code refactoring
+- [ ] Performance improvement
+
+## Related Issues
+<!-- Link any related issues using #issue_number -->
+Closes #
+
+## Changes Made
+<!-- List the main changes in this PR -->
+-
+-
+-
+
+## Testing
+<!-- Describe how you tested these changes -->
+- [ ] Added new tests
+- [ ] All existing tests pass
+- [ ] Manual testing performed
+
+## Checklist
+- [ ] My code follows the project's code style
+- [ ] I have run `ruff format .` and `ruff check .`
+- [ ] I have run `mypy .` with no errors
+- [ ] I have updated the documentation accordingly
+- [ ] I have added/updated tests for my changes
+- [ ] I have updated CHANGELOG.md
+- [ ] All new and existing tests pass
+
+## Screenshots (if applicable)
+<!-- Add screenshots to help explain your changes -->
+
+## Additional Notes
+<!-- Any additional information that reviewers should know -->

fastapi_refine-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,73 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          uv pip install --system -e ".[dev]"
+
+      - name: Run ruff check
+        run: ruff check .
+
+      - name: Run ruff format check
+        run: ruff format --check .
+
+      - name: Run mypy
+        run: mypy .
+
+      - name: Run tests
+        run: pytest
+        if: always()
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package
+        run: twine check dist/*
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/

fastapi_refine-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

fastapi_refine-0.1.0/.gitignore

@@ -0,0 +1,89 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# uv
+.uv/
+uv.lock
+
+# Lock files (libraries should not commit lock files)
+poetry.lock
+Pipfile.lock
+
+# Database files
+*.db
+*.sqlite
+*.sqlite3
+
+# Environment files
+.env
+.env.local
+.env.*.local

fastapi_refine-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

fastapi_refine-0.1.0/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2025-01-07
+
+### Added
+- Initial release
+- Query parameter parsing for Refine simple-rest conventions
+- Support for filtering (eq, ne, gte, lte, like operators)
+- Full-text search via `q` parameter
+- Multi-field sorting
+- Range-based and offset-based pagination
+- `RefineCRUDRouter` factory for automatic CRUD endpoint generation
+- Hook system for custom logic injection
+- Type-safe with full mypy support
+- Built-in type converters (parse_bool, parse_uuid)

fastapi_refine-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,94 @@
+# Contributing to fastapi-refine
+
+Thank you for your interest in contributing to fastapi-refine! This document provides guidelines for contributing.
+
+## Development Setup
+
+1. Clone the repository:
+```bash
+git clone https://github.com/koch3092/fastapi-refine.git
+cd fastapi-refine
+```
+
+2. Install dependencies with uv:
+```bash
+# Install uv if you haven't already
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Create virtual environment and install dependencies
+uv venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+uv pip install -e ".[dev]"
+```
+
+## Code Quality
+
+Before submitting a pull request, ensure your code passes all checks:
+
+```bash
+# Format code
+ruff format .
+
+# Run linter
+ruff check .
+
+# Run type checker
+mypy .
+
+# Run tests (when available)
+pytest
+```
+
+## Development Workflow
+
+1. Create a new branch for your feature or fix:
+```bash
+git checkout -b feature/your-feature-name
+```
+
+2. Make your changes and commit with descriptive messages:
+```bash
+git commit -m "Add feature: description of feature"
+```
+
+3. Push to your fork and submit a pull request:
+```bash
+git push origin feature/your-feature-name
+```
+
+## Pull Request Guidelines
+
+- Keep pull requests focused on a single feature or fix
+- Include tests for new functionality
+- Update documentation as needed
+- Follow the existing code style
+- Write clear commit messages
+- Update CHANGELOG.md with your changes
+
+## Code Style
+
+- Follow PEP 8 guidelines
+- Use type hints for all function parameters and return values
+- Write docstrings for all public APIs
+- Keep functions small and focused
+- Use meaningful variable names
+
+## Testing
+
+When tests are added to the project, please ensure:
+- All existing tests pass
+- New features include appropriate tests
+- Tests are clear and well-documented
+
+## Reporting Issues
+
+When reporting issues, please include:
+- Python version
+- fastapi-refine version
+- Minimal reproducible example
+- Expected behavior vs actual behavior
+- Any relevant error messages or stack traces
+
+## Questions?
+
+Feel free to open an issue for any questions about contributing!

fastapi_refine-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 koko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_refine-0.1.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include fastapi_refine *.py
+recursive-include fastapi_refine py.typed