lightapi 0.1.0__tar.gz → 0.1.2__tar.gz

lightapi-0.1.2/.github/workflows/pages-publish.yml

@@ -0,0 +1,59 @@
+name: Deploy GitHub Pages
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+  pull-requests: read
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs mkdocs-material mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin mkdocs-awesome-pages-plugin mkdocs-glightbox mkdocstrings[python]
+          pip install -e .[docs]
+
+      - name: Build site with MkDocs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          mkdocs build --strict
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './site'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

lightapi-0.1.2/.github/workflows/python-publish.yml

@@ -0,0 +1,129 @@
+# This workflow will upload a Python Package using Twine when code is pushed to main
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  push:
+    branches: [ "master" ]
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[test,dev]
+    
+    - name: Run tests
+      run: |
+        pytest tests/ -v
+
+  deploy:
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        token: ${{ secrets.GITHUB_TOKEN }}
+    
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine tomli-w tomli
+    
+    - name: Create version update script
+      run: |
+        cat > update_version.py << 'EOF'
+        import sys
+        import os
+        try:
+            import tomllib
+        except ImportError:
+            import tomli as tomllib
+        import tomli_w
+
+        def get_current_version():
+            with open('pyproject.toml', 'rb') as f:
+                data = tomllib.load(f)
+            return data['project']['version']
+
+        def increment_version(version):
+            parts = version.split('.')
+            parts[-1] = str(int(parts[-1]) + 1)
+            return '.'.join(parts)
+
+        def update_version(new_version):
+            with open('pyproject.toml', 'rb') as f:
+                data = tomllib.load(f)
+            
+            data['project']['version'] = new_version
+            
+            with open('pyproject.toml', 'wb') as f:
+                tomli_w.dump(data, f)
+
+        if __name__ == "__main__":
+            current = get_current_version()
+            new = increment_version(current)
+            update_version(new)
+            print(f"Updated version from {current} to {new}")
+            
+            # Write to GitHub output
+            with open(os.environ['GITHUB_OUTPUT'], 'a') as f:
+                f.write(f"new_version={new}\n")
+        EOF
+    
+    - name: Update version
+      id: update_version
+      run: python update_version.py
+    
+    - name: Build package
+      run: python -m build
+    
+    - name: Check package
+      run: twine check dist/*
+    
+    - name: Publish package to PyPI
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: |
+        twine upload dist/*
+    
+    - name: Commit version update
+      run: |
+        git config --local user.email "action@github.com"
+        git config --local user.name "GitHub Action"
+        git add pyproject.toml
+        git commit -m "Bump version to ${{ steps.update_version.outputs.new_version }}" || exit 0
+        git push

lightapi-0.1.2/.github/workflows/test-dev.yml

@@ -0,0 +1,86 @@
+# This workflow runs tests on the development branch
+# It runs tests but does not publish to PyPI
+
+name: Development Tests
+
+on:
+  push:
+    branches: [ "development" ]
+  pull_request:
+    branches: [ "development", "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[test,dev]
+    
+    - name: Run linting (Python 3.11 only)
+      if: matrix.python-version == '3.11'
+      run: |
+        # Install linting tools
+        pip install black isort flake8 mypy
+        
+        # Run code formatting checks (warn only in development)
+        echo "🔍 Checking code formatting..."
+        black --check --diff . || echo "⚠️  Code formatting issues found, but not failing in development"
+        
+        # Run import sorting checks (warn only in development)
+        echo "🔍 Checking import sorting..."
+        isort --check-only --diff . || echo "⚠️  Import sorting issues found, but not failing in development"
+        
+        # Run style checks (errors only)
+        echo "🔍 Checking critical style issues..."
+        flake8 lightapi/ --count --select=E9,F63,F7,F82 --show-source --statistics
+        
+        # Run additional style checks (warnings only)
+        echo "🔍 Checking style guidelines..."
+        flake8 lightapi/ --count --exit-zero --max-complexity=10 --max-line-length=88 --statistics
+    
+    - name: Run tests
+      run: |
+        pytest tests/ -v --tb=short
+    
+    - name: Test package build
+      if: matrix.python-version == '3.11'
+      run: |
+        pip install build
+        python -m build
+        
+    - name: Check package
+      if: matrix.python-version == '3.11'
+      run: |
+        pip install twine
+        twine check dist/*
+
+  # Job to check if all tests passed
+  test-summary:
+    needs: test
+    runs-on: ubuntu-latest
+    if: always()
+    steps:
+    - name: Check test results
+      run: |
+        if [ "${{ needs.test.result }}" = "success" ]; then
+          echo "✅ All tests passed! Ready for merge to master."
+        else
+          echo "❌ Tests failed. Please fix issues before merging."
+          exit 1
+        fi 

lightapi-0.1.2/.gitignore

@@ -0,0 +1,110 @@
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+.idea/**/aws.xml
+.idea/**/contentModel.xml
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+.idea/**/gradle.xml
+.idea/**/libraries
+cmake-build-*/
+.idea/**/mongoSettings.xml
+*.iws
+out/
+.idea_modules/
+atlassian-ide-plugin.xml
+.idea/replstate.xml
+.idea/sonarlint/
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+.idea/httpRequests
+.idea/caches/build_file_checksums.ser
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*.manifest
+*.spec
+pip-log.txt
+pip-delete-this-directory.txt
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+*.mo
+*.pot
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+instance/
+.webassets-cache
+.scrapy
+docs/_build/
+.pybuilder/
+target/
+.ipynb_checkpoints
+profile_default/
+ipython_config.py
+.pdm.toml
+__pypackages__/
+celerybeat-schedule
+celerybeat.pid
+*.sage.py
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.spyderproject
+.spyproject
+.ropeproject
+/site
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+cython_debug/
+.idea
+.idea
+alembic
+*.db

lightapi-0.1.2/.idx/dev.nix

@@ -0,0 +1,38 @@
+# To learn more about how to use Nix to configure your environment
+# see: https://developers.google.com/idx/guides/customize-idx-env
+{ pkgs, ... }: {
+  # Which nixpkgs channel to use.
+  channel = "stable-23.11"; # or "unstable"
+
+  # Use https://search.nixos.org/packages to find packages
+  packages = [
+    pkgs.python3
+  ];
+
+  # Sets environment variables in the workspace
+  env = {};
+  idx = {
+    # Search for the extensions you want on https://open-vsx.org/ and use "publisher.id"
+    extensions = [
+      "ms-python.python"
+    ];
+
+    # Workspace lifecycle hooks
+    workspace = {
+      # Runs when a workspace is first created
+      onCreate = {
+        create-venv = ''
+          python -m venv .venv
+          source .venv/bin/activate
+          pip install -e .[test,docs]
+        '';
+      };
+      # Runs when the workspace is (re)started
+      onStart = {
+        #activate-venv = ''
+        #  echo "source .venv/bin/activate" >> ~/.bashrc
+        #'';
+      };
+    };
+  };
+}

lightapi-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 iklobato
+
+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.

lightapi-0.1.2/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.4
+Name: lightapi
+Version: 0.1.2
+Summary: A lightweight framework for building API endpoints using Python's native libraries.
+Project-URL: Repository, https://github.com/henriqueblobato/LightApi
+Project-URL: Issues, https://github.com/henriqueblobato/LightApi/issues
+Project-URL: Homepage, https://github.com/henriqueblobato/LightApi
+Author-email: iklobato <iklobato1@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: api,endpoint,framework,lightweight,rest,restful
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.8.1
+Requires-Dist: aiohttp<4.0.0,>=3.9.5
+Requires-Dist: pyjwt<3.0.0,>=2.8.0
+Requires-Dist: redis<6.0.0,>=5.0.0
+Requires-Dist: sqlalchemy<3.0.0,>=2.0.30
+Requires-Dist: starlette<1.0.0,>=0.37.0
+Requires-Dist: uvicorn<1.0.0,>=0.30.0
+Provides-Extra: dev
+Requires-Dist: black<24.0.0,>=23.3.0; extra == 'dev'
+Requires-Dist: flake8<7.0.0,>=6.0.0; extra == 'dev'
+Requires-Dist: isort<6.0.0,>=5.12.0; extra == 'dev'
+Requires-Dist: mypy<2.0.0,>=1.3.0; extra == 'dev'
+Requires-Dist: pytest<8.0.0,>=7.3.1; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-awesome-pages-plugin; extra == 'docs'
+Requires-Dist: mkdocs-git-authors-plugin; extra == 'docs'
+Requires-Dist: mkdocs-git-committers-plugin-2; extra == 'docs'
+Requires-Dist: mkdocs-git-revision-date-localized-plugin; extra == 'docs'
+Requires-Dist: mkdocs-glightbox; extra == 'docs'
+Requires-Dist: mkdocs-material; extra == 'docs'
+Requires-Dist: mkdocstrings[python]; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: httpx<1.0.0,>=0.27.0; extra == 'test'
+Requires-Dist: pyjwt<3.0.0,>=2.8.0; extra == 'test'
+Requires-Dist: pytest<8.0.0,>=7.3.1; extra == 'test'
+Requires-Dist: redis<6.0.0,>=5.0.0; extra == 'test'
+Requires-Dist: starlette<1.0.0,>=0.37.0; extra == 'test'
+Requires-Dist: uvicorn<1.0.0,>=0.30.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# LightAPI
+
+[![PyPI version](https://badge.fury.io/py/lightapi.svg)](https://badge.fury.io/py/lightapi)
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A lightweight, fast, and easy-to-use web API framework for Python with automatic REST endpoint generation, built-in authentication, caching, and more.
+
+## Features
+
+- 🚀 **Zero-boilerplate REST APIs** - Automatically generate CRUD operations from SQLAlchemy models
+- 🔐 **Built-in Authentication** - JWT authentication with automatic CORS handling
+- ⚡ **High Performance** - Built on Starlette for async support and speed
+- 💾 **Smart Caching** - Redis-based caching with automatic invalidation
+- 📊 **Request Validation** - Automatic request validation and error handling
+- 🔍 **Advanced Filtering** - Query filtering, pagination, and sorting out of the box
+- 📖 **Auto Documentation** - Automatic OpenAPI/Swagger documentation generation
+- 🔧 **Flexible Middleware** - Easy middleware system for custom logic
+- 🗄️ **Database Integration** - Seamless SQLAlchemy integration with automatic table creation
+- ⚙️ **Environment Configuration** - Easy configuration management
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install lightapi
+```
+
+### Basic Usage
+
+```python
+from lightapi import LightApi
+from lightapi.database import Base
+from sqlalchemy import Column, Integer, String
+
+# Define your model
+class User(Base):
+    __tablename__ = "users"
+    
+    id = Column(Integer, primary_key=True)
+    name = Column(String(50))
+    email = Column(String(100))
+
+# Create API instance
+app = LightApi()
+
+# Register your model - automatically creates CRUD endpoints
+app.register(User)
+
+# Run the server
+if __name__ == "__main__":
+    app.run()
+```
+
+That's it! You now have a fully functional REST API with:
+- `GET /users` - List all users with filtering and pagination
+- `GET /users/{id}` - Get user by ID
+- `POST /users` - Create new user
+- `PUT /users/{id}` - Update user
+- `DELETE /users/{id}` - Delete user
+- `OPTIONS /users` - CORS preflight support
+
+## Documentation
+
+Visit our comprehensive documentation at: https://iklobato.github.io/lightapi/
+
+- [Getting Started Guide](https://iklobato.github.io/lightapi/getting-started/installation/)
+- [API Reference](https://iklobato.github.io/lightapi/api-reference/core/)
+- [Examples](https://iklobato.github.io/lightapi/examples/basic-rest/)
+
+## Advanced Features
+
+### Authentication
+
+```python
+from lightapi.auth import JWTAuthentication
+
+# Add JWT authentication
+auth = JWTAuthentication(secret_key="your-secret-key")
+app.add_middleware(auth)
+
+# Protected endpoints automatically require valid JWT tokens
+```
+
+### Caching
+
+```python
+from lightapi.cache import RedisCache
+
+# Add Redis caching
+cache = RedisCache(host="localhost", port=6379)
+app.register(User, cache=cache, cache_ttl=300)  # 5 minutes TTL
+```
+
+### Validation
+
+```python
+from lightapi.rest import Validator
+
+class UserValidator(Validator):
+    def validate_post(self, data):
+        if not data.get("email"):
+            raise ValueError("Email is required")
+        return data
+
+app.register(User, validator=UserValidator())
+```
+
+### Middleware
+
+```python
+from lightapi.core import Middleware
+
+class LoggingMiddleware(Middleware):
+    async def process(self, request, call_next):
+        print(f"Request: {request.method} {request.url}")
+        response = await call_next(request)
+        print(f"Response: {response.status_code}")
+        return response
+
+app.add_middleware(LoggingMiddleware())
+```
+
+## Why LightAPI?
+
+- **Rapid Development**: Get REST APIs running in minutes, not hours
+- **Production Ready**: Built-in security, caching, and error handling
+- **Flexible**: Customize every aspect while keeping defaults simple
+- **Modern**: Async support, type hints, and contemporary Python practices
+- **Well Documented**: Comprehensive docs with real-world examples
+
+## Examples
+
+Check out the [examples directory](./examples/) for complete applications:
+
+- [Basic REST API](./examples/basic_rest_api.py) - Simple CRUD operations
+- [Authentication](./examples/auth_example.py) - JWT authentication
+- [Caching](./examples/caching_example.py) - Redis caching implementation
+- [Validation](./examples/validation_example.py) - Request validation
+- [Middleware](./examples/middleware_example.py) - Custom middleware
+- [Filtering & Pagination](./examples/filtering_pagination_example.py) - Advanced queries
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+**LightAPI** - *Making web APIs light and fast* ⚡
+
+<!-- Testing development pipeline -->