lightapi 0.1.1__tar.gz → 0.1.3__tar.gz

{lightapi-0.1.1 → lightapi-0.1.3}/.github/workflows/python-publish.yml

@@ -127,3 +127,56 @@ jobs:
         git add pyproject.toml
         git commit -m "Bump version to ${{ steps.update_version.outputs.new_version }}" || exit 0
         git push
+    
+    - name: Create Git Tag
+      run: |
+        git tag v${{ steps.update_version.outputs.new_version }}
+        git push origin v${{ steps.update_version.outputs.new_version }}
+    
+    - name: Generate Release Notes
+      id: release_notes
+      run: |
+        # Get commits since last tag
+        LAST_TAG=$(git describe --tags --abbrev=0 HEAD~1 2>/dev/null || echo "")
+        if [ -z "$LAST_TAG" ]; then
+          # First release - get all commits
+          COMMITS=$(git log --pretty=format:"- %s (%h)" --no-merges HEAD~10..HEAD)
+        else
+          # Get commits since last tag
+          COMMITS=$(git log --pretty=format:"- %s (%h)" --no-merges $LAST_TAG..HEAD~1)
+        fi
+        
+        # Create release notes file
+        cat > release_notes.md << EOF
+        ## 🚀 Release v${{ steps.update_version.outputs.new_version }}
+        
+        ### What's Changed
+        $COMMITS
+        
+        ### 📦 Installation
+        \`\`\`bash
+        pip install lightapi==${{ steps.update_version.outputs.new_version }}
+        \`\`\`
+        
+        ### 📖 Documentation
+        - [Getting Started](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/)
+        
+        **Full Changelog**: https://github.com/iklobato/lightapi/compare/${LAST_TAG}...v${{ steps.update_version.outputs.new_version }}
+        EOF
+        
+        echo "Generated release notes for v${{ steps.update_version.outputs.new_version }}"
+    
+    - name: Create GitHub Release
+      uses: softprops/action-gh-release@v1
+      with:
+        tag_name: v${{ steps.update_version.outputs.new_version }}
+        name: "LightAPI v${{ steps.update_version.outputs.new_version }}"
+        body_path: release_notes.md
+        draft: false
+        prerelease: false
+        files: |
+          dist/lightapi-${{ steps.update_version.outputs.new_version }}-py3-none-any.whl
+          dist/lightapi-${{ steps.update_version.outputs.new_version }}.tar.gz
+        token: ${{ secrets.GITHUB_TOKEN }}

{lightapi-0.1.1 → lightapi-0.1.3}/.github/workflows/test-dev.yml

@@ -38,14 +38,20 @@ jobs:
         # Install linting tools
         pip install black isort flake8 mypy
         
-        # Run code formatting checks
-        black --check --diff .
+        # 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
-        isort --check-only --diff .
+        # 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
+        # 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

lightapi-0.1.3/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.4
+Name: lightapi
+Version: 0.1.3
+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 -->

lightapi-0.1.3/README.md

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

{lightapi-0.1.1 → lightapi-0.1.3}/examples/auth_example.py

@@ -1,111 +1,121 @@
+import datetime
+import json
+
+import jwt
 from sqlalchemy import Column, Integer, String
-from lightapi.core import LightApi, Response, Middleware
-from lightapi.rest import RestEndpoint
+
 from lightapi.auth import JWTAuthentication
-from lightapi.models import Base, register_model_class
 from lightapi.config import config
-import jwt
-import datetime
-import json
+from lightapi.core import LightApi, Middleware, Response
+from lightapi.models import Base, register_model_class
+from lightapi.rest import RestEndpoint
+
 
 # Custom authentication class
 class CustomJWTAuth(JWTAuthentication):
     def __init__(self):
         super().__init__()
         self.secret_key = config.jwt_secret
-        
+
     def authenticate(self, request):
         # Use the parent class implementation
         return super().authenticate(request)
 
+
 # Login endpoint to get a token
 class AuthEndpoint(RestEndpoint):
     __abstract__ = True  # Not a database model
-    
+
     def post(self, request):
-        data = getattr(request, 'data', {})
-        username = data.get('username')
-        password = data.get('password')
-        
+        data = getattr(request, "data", {})
+        username = data.get("username")
+        password = data.get("password")
+
         # Simple authentication (replace with database lookup in real apps)
         if username == "admin" and password == "password":
             # Create a JWT token
             payload = {
-                'sub': 'user_1',
-                'username': username,
-                'role': 'admin',
-                'exp': datetime.datetime.utcnow() + datetime.timedelta(hours=1)
+                "sub": "user_1",
+                "username": username,
+                "role": "admin",
+                "exp": datetime.datetime.utcnow() + datetime.timedelta(hours=1),
             }
             token = jwt.encode(payload, config.jwt_secret, algorithm="HS256")
-            
+
             return {"token": token}, 200
         else:
             return Response({"error": "Invalid credentials"}, status_code=401)
 
+
 # Protected resource that requires authentication
 class SecretResource(RestEndpoint):
     __abstract__ = True  # Not a database model
-    
+
     class Configuration:
         authentication_class = CustomJWTAuth
-    
+
     def get(self, request):
         try:
             # Access the user info stored during authentication
-            username = request.state.user.get('username')
-            role = request.state.user.get('role')
-            
+            username = request.state.user.get("username")
+            role = request.state.user.get("role")
+
             return {
                 "message": f"Hello, {username}! You have {role} access.",
-                "secret_data": "This is protected information"
+                "secret_data": "This is protected information",
             }, 200
         except Exception as e:
             import traceback
+
             print(f"Error in SecretResource.get: {e}")
             print(traceback.format_exc())
             return {"error": str(e)}, 500
 
+
 # Public endpoint that doesn't require authentication
 class PublicResource(RestEndpoint):
     __abstract__ = True  # Not a database model
-    
+
     def get(self, request):
         try:
             return {"message": "This is public information"}, 200
         except Exception as e:
             import traceback
+
             print(f"Error in PublicResource.get: {e}")
             print(traceback.format_exc())
             return {"error": str(e)}, 500
 
+
 # User profile endpoint that requires authentication
 @register_model_class
 class UserProfile(RestEndpoint):
-    __tablename__ = 'user_profiles'
-    
+    __tablename__ = "user_profiles"
+
     id = Column(Integer, primary_key=True)
     user_id = Column(String(50))
     full_name = Column(String(100))
     email = Column(String(100))
-    
+
     class Configuration:
         authentication_class = CustomJWTAuth
-    
+
     # Override GET to return only the current user's profile
     def get(self, request):
-        user_id = request.state.user.get('sub')
+        user_id = request.state.user.get("sub")
         profile = self.session.query(self.__class__).filter_by(user_id=user_id).first()
-        
+
         if profile:
             return {
                 "id": profile.id,
                 "user_id": profile.user_id,
                 "full_name": profile.full_name,
-                "email": profile.email
+                "email": profile.email,
             }, 200
         else:
             return Response({"error": "Profile not found"}, status_code=404)
 
+
 if __name__ == "__main__":
     app = LightApi(
         database_url="sqlite:///auth_example.db",
@@ -113,19 +123,25 @@ if __name__ == "__main__":
         swagger_version="1.0.0",
         swagger_description="Example showing JWT authentication with LightAPI",
     )
-    
-    app.register({
-        '/auth/login': AuthEndpoint,
-        '/public': PublicResource,
-        '/secret': SecretResource,
-        '/profile': UserProfile
-    })
-    
+
+    app.register(
+        {
+            "/auth/login": AuthEndpoint,
+            "/public": PublicResource,
+            "/secret": SecretResource,
+            "/profile": UserProfile,
+        }
+    )
+
     print("Server running at http://localhost:8000")
     print("API documentation available at http://localhost:8000/docs")
     print("\nTo get a token:")
-    print("curl -X POST http://localhost:8000/auth/login -H 'Content-Type: application/json' -d '{\"username\": \"admin\", \"password\": \"password\"}'")
+    print(
+        'curl -X POST http://localhost:8000/auth/login -H \'Content-Type: application/json\' -d \'{"username": "admin", "password": "password"}\''
+    )
     print("\nTo access protected resource:")
-    print("curl -X GET http://localhost:8000/secret -H 'Authorization: Bearer YOUR_TOKEN'")
-    
-    app.run(host="localhost", port=8000, debug=True) 
+    print(
+        "curl -X GET http://localhost:8000/secret -H 'Authorization: Bearer YOUR_TOKEN'"
+    )
+
+    app.run(host="localhost", port=8000, debug=True)

{lightapi-0.1.1 → lightapi-0.1.3}/examples/basic_rest_api.py

@@ -1,18 +1,20 @@
 from sqlalchemy import Column, Integer, String
+
 from lightapi.core import LightApi
-from lightapi.rest import RestEndpoint
 from lightapi.models import Base, register_model_class
+from lightapi.rest import RestEndpoint
+
 
 # Define a model that inherits from RestEndpoint
 @register_model_class
 class User(RestEndpoint):
-    __tablename__ = 'users'
-    
+    __tablename__ = "users"
+
     id = Column(Integer, primary_key=True)
     name = Column(String(100))
     email = Column(String(100))
     role = Column(String(50))
-    
+
     # The default implementation already includes:
     # - GET: List all users or get a specific user by ID
     # - POST: Create a new user
@@ -20,6 +22,7 @@ class User(RestEndpoint):
     # - DELETE: Delete a user
     # - OPTIONS: Return allowed methods
 
+
 if __name__ == "__main__":
     # Initialize the API with SQLite database
     app = LightApi(
@@ -28,12 +31,12 @@ if __name__ == "__main__":
         swagger_version="1.0.0",
         swagger_description="Simple REST API demonstrating basic CRUD operations",
     )
-    
+
     # Register our endpoint
-    app.register({'/users': User})
-    
+    app.register({"/users": User})
+
     print("Server running at http://localhost:8000")
     print("API documentation available at http://localhost:8000/docs")
-    
+
     # Run the server
-    app.run(host="localhost", port=8000, debug=True) 
+    app.run(host="localhost", port=8000, debug=True)