apikee 1.0.0__tar.gz

apikee-1.0.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.1
+Name: apikee
+Version: 1.0.0
+Summary: ApiKee - A lightweight API key validation library for FastAPI
+Home-page: https://github.com/apikee-dev/apikee-python
+Author: usmhic
+License: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi>=0.68.0
+Requires-Dist: aiohttp>=3.8.0
+
+# ApiKee Python
+
+ApiKee is a lightweight and easy-to-use library for managing and securing your FastAPI endpoints. Whether you want to validate API keys locally or via a server, ApiKee ensures smooth integration with minimal configuration.
+
+---
+
+## **Table of Contents**
+
+1. [Concept Overview](#concept-overview)
+2. [Installation](#installation)
+3. [Usage](#usage)
+   - [Local Validation](#1-local-validation)
+   - [Server Validation](#2-server-validation)
+4. [Server Validation Options](#server-validation-options)
+   - [Build Your Own Server](#1-build-your-own-server)
+   - [Use ApiKee Premium Server](#2-use-apikee-premium-server)
+5. [Contributing](#contributing)
+6. [License](#license)
+
+---
+
+## **Concept Overview**
+
+ApiKee provides two modes of operation:
+1. **Local Validation**: Validate API keys locally by comparing them to a predefined key.
+2. **Server Validation**: Send API keys to a server for validation and handle responses.
+
+---
+
+## **Installation**
+
+Install ApiKee using pip:
+```bash
+pip install apikee
+```
+
+---
+
+## **Usage**
+
+### **1. Local Validation**
+```python
+from fastapi import FastAPI, Request
+from apikee.config import config
+from apikee.decorators import apikey
+
+app = FastAPI()
+
+# Set your local API key
+config.local_key = "my-local-api-key"
+
+@app.get("/local-protected")
+@apikey()
+async def local_protected_endpoint(request: Request):
+    return {"message": "Local validation successful"}
+```
+
+### **2. Server Validation**
+```python
+from fastapi import FastAPI, Request
+from apikee.config import config
+from apikee.decorators import apikey
+
+app = FastAPI()
+
+# Configure server validation
+config.server_key = "my-server-key"
+config.server_url = "https://premium.apikee.com"
+config.project_id = "my-project-id"
+config.environment = "staging"
+
+@app.get("/server-protected")
+@apikey(endpoint_id="endpoint-id")
+async def server_protected_endpoint(request: Request):
+    return {"message": "Server validation successful"}
+```
+
+---
+
+## **Server Validation Options**
+
+### **1. Build Your Own Server**
+You can create your own validation server by following the specifications provided in the [ApiKee API Documentation](https://api.yourdocumentation.com).
+
+### **2. Use ApiKee Premium Server**
+Use the pre-built ApiKee server available at [apikee.com](https://apikee.com) to handle validation, analytics, and centralized key management.
+
+---
+
+## **Contributing**
+
+Contributions are welcome! Follow the standard fork-branch-PR model to contribute. For detailed instructions, check the [GitHub repository](https://github.com/your-repo-link).
+
+---
+
+## **License**
+
+This library is open-source and released under the MIT License. 
+- **Note**: The open-source license applies only to the library.
+- For server validation, you must either:
+  - Build your own server respecting the ApiKee specifications.
+  - Use the paid ApiKee server at [apikee.com](https://apikee.com).

apikee-1.0.0/README.md

@@ -0,0 +1,102 @@
+# ApiKee Python
+
+ApiKee is a lightweight and easy-to-use library for managing and securing your FastAPI endpoints. Whether you want to validate API keys locally or via a server, ApiKee ensures smooth integration with minimal configuration.
+
+---
+
+## **Table of Contents**
+
+1. [Concept Overview](#concept-overview)
+2. [Installation](#installation)
+3. [Usage](#usage)
+   - [Local Validation](#1-local-validation)
+   - [Server Validation](#2-server-validation)
+4. [Server Validation Options](#server-validation-options)
+   - [Build Your Own Server](#1-build-your-own-server)
+   - [Use ApiKee Premium Server](#2-use-apikee-premium-server)
+5. [Contributing](#contributing)
+6. [License](#license)
+
+---
+
+## **Concept Overview**
+
+ApiKee provides two modes of operation:
+1. **Local Validation**: Validate API keys locally by comparing them to a predefined key.
+2. **Server Validation**: Send API keys to a server for validation and handle responses.
+
+---
+
+## **Installation**
+
+Install ApiKee using pip:
+```bash
+pip install apikee
+```
+
+---
+
+## **Usage**
+
+### **1. Local Validation**
+```python
+from fastapi import FastAPI, Request
+from apikee.config import config
+from apikee.decorators import apikey
+
+app = FastAPI()
+
+# Set your local API key
+config.local_key = "my-local-api-key"
+
+@app.get("/local-protected")
+@apikey()
+async def local_protected_endpoint(request: Request):
+    return {"message": "Local validation successful"}
+```
+
+### **2. Server Validation**
+```python
+from fastapi import FastAPI, Request
+from apikee.config import config
+from apikee.decorators import apikey
+
+app = FastAPI()
+
+# Configure server validation
+config.server_key = "my-server-key"
+config.server_url = "https://premium.apikee.com"
+config.project_id = "my-project-id"
+config.environment = "staging"
+
+@app.get("/server-protected")
+@apikey(endpoint_id="endpoint-id")
+async def server_protected_endpoint(request: Request):
+    return {"message": "Server validation successful"}
+```
+
+---
+
+## **Server Validation Options**
+
+### **1. Build Your Own Server**
+You can create your own validation server by following the specifications provided in the [ApiKee API Documentation](https://api.yourdocumentation.com).
+
+### **2. Use ApiKee Premium Server**
+Use the pre-built ApiKee server available at [apikee.com](https://apikee.com) to handle validation, analytics, and centralized key management.
+
+---
+
+## **Contributing**
+
+Contributions are welcome! Follow the standard fork-branch-PR model to contribute. For detailed instructions, check the [GitHub repository](https://github.com/your-repo-link).
+
+---
+
+## **License**
+
+This library is open-source and released under the MIT License. 
+- **Note**: The open-source license applies only to the library.
+- For server validation, you must either:
+  - Build your own server respecting the ApiKee specifications.
+  - Use the paid ApiKee server at [apikee.com](https://apikee.com).

apikee-1.0.0/apikee/__init__.py

@@ -0,0 +1,10 @@
+from .config import config
+from .decorators import apikey
+from .middleware import SwaggerProtectedMiddleware
+
+def init_app(app):
+    """
+    Initialize the FastAPI application with ApiKee configurations.
+    This automatically adds middleware to protect Swagger endpoints.
+    """
+    app.add_middleware(SwaggerProtectedMiddleware)

apikee-1.0.0/apikee/config.py

@@ -0,0 +1,13 @@
+from typing import Optional
+
+class ApiKeeConfig:
+    def __init__(self, local_key: Optional[str] = None, server_key: Optional[str] = None,
+                 server_url: Optional[str] = None, project_id: Optional[str] = None, environment: Optional[str] = None):
+        self.local_key = local_key
+        self.server_key = server_key
+        self.server_url = server_url
+        self.project_id = project_id
+        self.environment = environment
+
+# Global configuration instance
+config = ApiKeeConfig()

apikee-1.0.0/apikee/decorators.py

@@ -0,0 +1,29 @@
+from fastapi import HTTPException, Request
+from functools import wraps
+from .config import config
+from .server_client import validate_with_server
+
+def apikey(endpoint_id: str = None):
+    """
+    Decorator for API key validation. 
+    - If `endpoint_id` is provided, server validation is used.
+    - If `endpoint_id` is not provided, local validation is used.
+    """
+    def decorator(func):
+        @wraps(func)
+        async def wrapper(request: Request, *args, **kwargs):
+            api_key = request.headers.get("X-Api-Key")
+            if not api_key:
+                raise HTTPException(status_code=403, detail="API key missing")
+
+            if endpoint_id:  # Server validation
+                is_valid, message = await validate_with_server(api_key, endpoint_id)
+                if not is_valid:
+                    raise HTTPException(status_code=403, detail=message)
+            else:  # Local validation
+                if not config.local_key or api_key != config.local_key:
+                    raise HTTPException(status_code=403, detail="Invalid API key")
+            
+            return await func(request, *args, **kwargs)
+        return wrapper
+    return decorator

apikee-1.0.0/apikee/exceptions.py

@@ -0,0 +1,2 @@
+class ApiKeeError(Exception):
+    pass

apikee-1.0.0/apikee/middleware.py

@@ -0,0 +1,18 @@
+from fastapi import HTTPException, Request
+from starlette.middleware.base import BaseHTTPMiddleware
+from .config import config
+
+class SwaggerProtectedMiddleware(BaseHTTPMiddleware):
+    """
+    Middleware to protect Swagger and Redoc documentation endpoints.
+    """
+
+    def __init__(self, app):
+        super().__init__(app)
+
+    async def dispatch(self, request: Request, call_next):
+        if request.url.path in ["/docs", "/redoc", "/openapi.json"]:
+            api_key = request.headers.get("X-Api-Key")
+            if not api_key or api_key != config.local_key:
+                raise HTTPException(status_code=403, detail="Access to documentation is restricted")
+        return await call_next(request)

apikee-1.0.0/apikee/server_client.py

@@ -0,0 +1,22 @@
+import aiohttp
+from .config import config
+
+async def validate_with_server(api_key: str, endpoint_id: str) -> (bool, str):
+    if not config.server_url or not config.server_key:
+        return False, "Server configuration is incomplete"
+
+    payload = {
+        "api_key": api_key,
+        "endpoint_id": endpoint_id,
+        "project_id": config.project_id,
+        "environment": config.environment,
+    }
+
+    headers = {"Authorization": f"Bearer {config.server_key}"}
+
+    async with aiohttp.ClientSession() as session:
+        async with session.post(f"{config.server_url}/validate", json=payload, headers=headers) as response:
+            if response.status == 200:
+                data = await response.json()
+                return data.get("isValid", False), data.get("message", "Unknown error")
+            return False, f"Server error: {response.status}"

apikee-1.0.0/apikee.egg-info/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.1
+Name: apikee
+Version: 1.0.0
+Summary: ApiKee - A lightweight API key validation library for FastAPI
+Home-page: https://github.com/apikee-dev/apikee-python
+Author: usmhic
+License: MIT
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi>=0.68.0
+Requires-Dist: aiohttp>=3.8.0
+
+# ApiKee Python
+
+ApiKee is a lightweight and easy-to-use library for managing and securing your FastAPI endpoints. Whether you want to validate API keys locally or via a server, ApiKee ensures smooth integration with minimal configuration.
+
+---
+
+## **Table of Contents**
+
+1. [Concept Overview](#concept-overview)
+2. [Installation](#installation)
+3. [Usage](#usage)
+   - [Local Validation](#1-local-validation)
+   - [Server Validation](#2-server-validation)
+4. [Server Validation Options](#server-validation-options)
+   - [Build Your Own Server](#1-build-your-own-server)
+   - [Use ApiKee Premium Server](#2-use-apikee-premium-server)
+5. [Contributing](#contributing)
+6. [License](#license)
+
+---
+
+## **Concept Overview**
+
+ApiKee provides two modes of operation:
+1. **Local Validation**: Validate API keys locally by comparing them to a predefined key.
+2. **Server Validation**: Send API keys to a server for validation and handle responses.
+
+---
+
+## **Installation**
+
+Install ApiKee using pip:
+```bash
+pip install apikee
+```
+
+---
+
+## **Usage**
+
+### **1. Local Validation**
+```python
+from fastapi import FastAPI, Request
+from apikee.config import config
+from apikee.decorators import apikey
+
+app = FastAPI()
+
+# Set your local API key
+config.local_key = "my-local-api-key"
+
+@app.get("/local-protected")
+@apikey()
+async def local_protected_endpoint(request: Request):
+    return {"message": "Local validation successful"}
+```
+
+### **2. Server Validation**
+```python
+from fastapi import FastAPI, Request
+from apikee.config import config
+from apikee.decorators import apikey
+
+app = FastAPI()
+
+# Configure server validation
+config.server_key = "my-server-key"
+config.server_url = "https://premium.apikee.com"
+config.project_id = "my-project-id"
+config.environment = "staging"
+
+@app.get("/server-protected")
+@apikey(endpoint_id="endpoint-id")
+async def server_protected_endpoint(request: Request):
+    return {"message": "Server validation successful"}
+```
+
+---
+
+## **Server Validation Options**
+
+### **1. Build Your Own Server**
+You can create your own validation server by following the specifications provided in the [ApiKee API Documentation](https://api.yourdocumentation.com).
+
+### **2. Use ApiKee Premium Server**
+Use the pre-built ApiKee server available at [apikee.com](https://apikee.com) to handle validation, analytics, and centralized key management.
+
+---
+
+## **Contributing**
+
+Contributions are welcome! Follow the standard fork-branch-PR model to contribute. For detailed instructions, check the [GitHub repository](https://github.com/your-repo-link).
+
+---
+
+## **License**
+
+This library is open-source and released under the MIT License. 
+- **Note**: The open-source license applies only to the library.
+- For server validation, you must either:
+  - Build your own server respecting the ApiKee specifications.
+  - Use the paid ApiKee server at [apikee.com](https://apikee.com).

apikee-1.0.0/apikee.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+setup.py
+apikee/__init__.py
+apikee/config.py
+apikee/decorators.py
+apikee/exceptions.py
+apikee/middleware.py
+apikee/server_client.py
+apikee.egg-info/PKG-INFO
+apikee.egg-info/SOURCES.txt
+apikee.egg-info/dependency_links.txt
+apikee.egg-info/requires.txt
+apikee.egg-info/top_level.txt

apikee-1.0.0/apikee.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

apikee-1.0.0/apikee.egg-info/requires.txt

@@ -0,0 +1,2 @@
+fastapi>=0.68.0
+aiohttp>=3.8.0

apikee-1.0.0/apikee.egg-info/top_level.txt

@@ -0,0 +1 @@
+apikee

apikee-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

apikee-1.0.0/setup.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="apikee",
+    version="1.0.0",
+    author="usmhic",
+    description="ApiKee - A lightweight API key validation library for FastAPI",
+    packages=find_packages(),
+    install_requires=[
+        "fastapi>=0.68.0",
+        "aiohttp>=3.8.0",
+    ],
+    python_requires=">=3.7",
+    include_package_data=True,
+    url="https://github.com/apikee-dev/apikee-python",
+    license="MIT",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+)