fasthtml-auth 0.1.0__py3-none-any.whl

fasthtml_auth-0.1.0.dist-info/METADATA

@@ -0,0 +1,413 @@
+Metadata-Version: 2.4
+Name: fasthtml-auth
+Version: 0.1.0
+Summary: Complete authentication system for FastHTML applications with beautiful UI, role-based access control, and session management
+Author-email: John Richmond <confusedjohn46@gmail.com>
+Maintainer-email: John Richmond <confusedjohn46@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 John Richmond
+        
+        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 CONTRIBUTORS 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.
+Project-URL: Homepage, https://github.com/fromLittleAcorns/fasthtml-auth
+Project-URL: Documentation, https://github.com/fromLittleAcorns/fasthtml-auth#readme
+Project-URL: Repository, https://github.com/fromLittleAcorns/fasthtml-toolkit
+Project-URL: Issues, https://github.com/fromLittleAcorns/fasthtml-auth/issues
+Project-URL: Changelog, https://github.com/fromLittleAcorns/fasthtml-auth/blob/main/CHANGELOG.md
+Keywords: fasthtml,authentication,web,framework,auth,login,session,bcrypt,monsterui
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-fasthtml>=0.12.0
+Requires-Dist: monsterui>=1.0.20
+Requires-Dist: fastlite>=0.2.0
+Requires-Dist: bcrypt>=4.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.4.0; extra == "docs"
+Requires-Dist: mkdocs-material>=8.5.0; extra == "docs"
+Requires-Dist: mkdocs-autorefs>=0.4.0; extra == "docs"
+Dynamic: license-file
+
+# FastHTML-Auth
+
+A comprehensive, drop-in authentication system for FastHTML applications with beautiful UI components, session management, and role-based access control.
+
+This repro is intended to simplify the process of setting up a authentiation, user management and database setup for fastHTML apps.  Some of the code is based upon examples from Answer.ai code base, and for more information about fastHTML see [fastHTML](https://www.fastht.ml)
+
+## Installation
+
+```bash
+pip install fasthtml-auth
+
+## Features
+
+- 🔐 **Secure Authentication** - Bcrypt password hashing, session management
+- 👤 **User Management** - Registration, profile management, role-based access
+- 🎨 **Beautiful UI** - Styled with MonsterUI components, fully responsive
+- 🛡️ **Role-Based Access Control** - User, Manager, Admin roles with decorators
+- 🔄 **Session Management** - Automatic session handling with FastHTML
+- 📱 **Mobile Friendly** - Responsive design works on all devices
+- ⚡ **Easy Integration** - Drop-in solution with minimal setup required
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install fasthtml-auth
+```
+
+### Quick Start
+
+```python
+from fasthtml.common import *
+from monsterui.all import *
+from fasthtml_auth import AuthManager
+
+# Initialize authentication system
+auth = AuthManager(
+    db_path="data/app.db",
+    config={
+        'allow_registration': True,
+        'public_paths': ['/about', '/contact']
+    }
+)
+
+# Set up database and middleware
+db = auth.initialize()
+beforeware = auth.create_beforeware()
+
+# Create FastHTML app with authentication
+app = FastHTML(
+    before=beforeware,
+    secret_key='your-secret-key-change-in-production',
+    hdrs=Theme.blue.headers()  # MonsterUI styling
+)
+
+# Register authentication routes
+auth.register_routes(app)
+
+# Your protected routes
+@app.route("/")
+def dashboard(req):
+    user = req.scope['user']  # Automatically available
+    return Title("Dashboard"), H1(f"Welcome, {user.username}!")
+
+@app.route("/admin")
+@auth.require_admin()
+def admin_panel(req):
+    return Title("Admin"), H1("Admin Only Area")
+
+if __name__ == "__main__":
+    serve(port=5000)
+```
+
+That's it! Your app now has:
+- Login/logout at `/auth/login` and `/auth/logout`
+- User registration at `/auth/register` 
+- Profile management at `/auth/profile`
+- Role-based access control
+- Beautiful, responsive forms
+
+## Configuration
+
+```python
+config = {
+    'login_path': '/auth/login',           # Custom login URL
+    'public_paths': ['/about', '/api'],    # Routes that don't require auth
+    'allow_registration': True,            # Enable user registration
+    'allow_password_reset': False,         # Enable password reset (coming soon)
+}
+
+auth = AuthManager(db_path="data/app.db", config=config)
+```
+
+## User Roles and Access Control
+
+### Available Roles
+- **user** - Basic authenticated user
+- **manager** - Manager privileges + user access  
+- **admin** - Full system access
+
+### Role-Based Route Protection
+
+```python
+# Require specific roles
+@app.route("/manager-area")
+@auth.require_role('manager', 'admin')
+def manager_view(req, *args, **kwargs):
+    return H1("Manager+ Only")
+
+# Admin only shortcut
+@app.route("/admin")
+@auth.require_admin()
+def admin_panel(req, *args, **kwargs):
+    return H1("Admin Only")
+
+# Check roles in templates
+@app.route("/dashboard")
+def dashboard(req):
+    user = req.scope['user']
+    
+    admin_link = A("Admin Panel", href="/admin") if user.role == 'admin' else None
+    manager_link = A("Manager Area", href="/manager") if user.role in ['manager', 'admin'] else None
+    
+    return Div(admin_link, manager_link)
+```
+
+## User Object
+
+In protected routes, `req.scope['user']` contains:
+
+```python
+user.id          # Unique user ID  
+user.username    # Username
+user.email       # Email address
+user.role        # 'user', 'manager', or 'admin'
+user.active      # Boolean - account status
+user.created_at  # Account creation timestamp
+user.last_login  # Last login timestamp
+```
+
+## Database Schema
+
+FastHTML-Auth automatically creates these tables:
+
+```sql
+-- Users table
+CREATE TABLE user (
+   id INTEGER PRIMARY KEY,
+   username TEXT UNIQUE NOT NULL,
+   email TEXT UNIQUE NOT NULL, 
+   password TEXT NOT NULL,        -- Bcrypt hashed
+   role TEXT DEFAULT 'user',
+   created_at TEXT,
+   last_login TEXT,
+   active INTEGER DEFAULT 1
+);
+
+-- Sessions table (for future use)
+CREATE TABLE session (
+   id TEXT PRIMARY KEY,
+   user_id INTEGER,
+   data TEXT,
+   expires_at TEXT,
+   created_at TEXT
+);
+```
+
+## Styling and Themes
+
+FastHTML-Auth uses [MonsterUI](https://github.com/pixeltable/monster-ui) for beautiful, consistent styling.
+
+```python
+# Choose your theme
+app = FastHTML(
+    before=beforeware,
+    hdrs=Theme.blue.headers()    # or Theme.red, Theme.green, etc.
+)
+```
+
+All forms include:
+- Responsive card-based layouts
+- Professional input styling  
+- Clear error/success messages
+- Loading states and validation
+- Mobile-optimized design
+
+## API Reference
+
+### AuthManager
+
+```python
+class AuthManager:
+    def __init__(self, db_path="data/app.db", config=None)
+    def initialize(self) -> Database
+    def create_beforeware(self, additional_public_paths=None) -> Beforeware
+    def register_routes(self, app, prefix="/auth") -> Dict
+    def require_role(self, *roles) -> Decorator
+    def require_admin(self) -> Decorator
+    def get_user(self, username: str) -> Optional[User]
+```
+
+### Default Admin Account
+
+A default admin account is created automatically:
+- **Username**: `admin`  
+- **Password**: `admin123`
+- **Role**: `admin`
+
+⚠️ **Change this password in production!**
+
+## Available Routes
+
+FastHTML-Auth automatically registers these routes:
+
+- `GET /auth/login` - Login form
+- `POST /auth/login` - Login submission  
+- `GET /auth/logout` - Logout and redirect
+- `GET /auth/register` - Registration form (if enabled)
+- `POST /auth/register` - Registration submission (if enabled)
+- `GET /auth/profile` - User profile management
+- `POST /auth/profile` - Profile update submission
+
+## Examples
+
+### Complete Example App
+
+```python
+from fasthtml.common import *
+from monsterui.all import *
+from fasthtml_auth import AuthManager
+
+# Initialize auth
+auth = AuthManager(
+    db_path="data/myapp.db",
+    config={
+        'allow_registration': True,
+        'public_paths': ['/about', '/pricing', '/contact']
+    }
+)
+
+db = auth.initialize()
+beforeware = auth.create_beforeware()
+
+app = FastHTML(
+    before=beforeware,
+    secret_key='super-secret-change-me',
+    hdrs=Theme.blue.headers()
+)
+
+auth.register_routes(app)
+
+# Public landing page
+@app.route("/")
+def home(req):
+    user = req.scope.get('user')  # None if not logged in
+    
+    if user:
+        return RedirectResponse('/dashboard')
+    
+    return Title("Welcome"), Container(
+        H1("My Awesome App"),
+        P("Please login to continue"),
+        A("Login", href="/auth/login", cls=ButtonT.primary),
+        A("Sign Up", href="/auth/register", cls=ButtonT.secondary)
+    )
+
+# Protected dashboard
+@app.route("/dashboard")  
+def dashboard(req, *args, **kwargs):
+    user = req.scope['user']
+    
+    return Title("Dashboard"), Container(
+        H1(f"Welcome back, {user.username}!"),
+        
+        # Role-specific content
+        Card(
+            CardHeader("Your Account"),
+            CardBody(
+                P(f"Role: {user.role.title()}"),
+                P(f"Member since: {user.created_at[:10]}"),
+                A("Edit Profile", href="/auth/profile", cls=ButtonT.primary)
+            )
+        ) if user.role == 'user' else None,
+        
+        # Manager content
+        Card(
+            CardHeader("Management Tools"),
+            CardBody(
+                A("View Reports", href="/reports", cls=ButtonT.primary),
+                A("Manage Users", href="/users", cls=ButtonT.secondary)
+            )
+        ) if user.role in ['manager', 'admin'] else None
+    )
+
+if __name__ == "__main__":
+    serve(port=5000)
+```
+
+## Dependencies
+
+- `fasthtml` - Web framework
+- `monsterui` - UI components
+- `fastlite` - Database ORM
+- `bcrypt` - Password hashing
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/fromlittleacorns/fasthtml-auth.git
+cd fasthtml-auth
+
+# Install development dependencies
+pip install -e .[dev]
+
+# Run tests
+python -m pytest
+
+# Run example
+python examples/complete_app.py
+```
+
+## Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Changelog
+
+### v0.1.0
+- Initial release
+- Basic authentication system
+- MonsterUI integration
+- Role-based access control
+- User registration and profiles
+
+---
+
+**FastHTML-Auth** - Authentication made simple for FastHTML applications.
+
+For more examples and documentation, visit: [https://github.com/fromlittleacorns/fasthtml-auth](https://github.com/fromlittleacorns/fasthtml-auth)

fasthtml_auth-0.1.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+fasthtml_auth/__init__.py,sha256=6y-RXppiFdNaMAMbWNUxaEZmapDe_gGQfgRW69wINH8,780
+fasthtml_auth/database.py,sha256=xVSqZD8-zA1qq166LsQMQvxMkMaJhLfIv1QIXX0Bgvc,1079
+fasthtml_auth/forms.py,sha256=zlgaq5cmHQspjwyz5e48yuC03JL5D4dSm_6gOKnBnP0,15163
+fasthtml_auth/init.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fasthtml_auth/manager.py,sha256=1sI6S4HLji9FdZNxPCp-73wsihkyaNvCG_DzibfazDk,2663
+fasthtml_auth/middleware.py,sha256=CplYcPjzkTRcVGXr19ClDG3inoaxHGK5ZmQUWjboCOc,3341
+fasthtml_auth/models.py,sha256=WMZuvW9ikB9y8Zql4Q68ItvzVYxNkGuLWsR5gnPp86w,2323
+fasthtml_auth/repository.py,sha256=27j7ps4RurezPKUjGBMhUGQBofRER2GeSFgSe7FPjic,4395
+fasthtml_auth/routes.py,sha256=6NBLxppYi53SfUjyMnXLb3gzl9GlswqdTZgEg36-FGc,9025
+fasthtml_auth/utils.py,sha256=NsdmkcxVLfahe_BVc8GqawadwJgilX6NbZt-gMdiibk,1451
+fasthtml_auth-0.1.0.dist-info/licenses/LICENSE,sha256=EnPW65jfIuV5msUjRTyzltVV2Aqo3HcIyM6z3hUloXQ,1064
+fasthtml_auth-0.1.0.dist-info/METADATA,sha256=aeBCysMLiSnnlFz3myExT9FH2vMuuW1uFJ7ANMnvKiU,12395
+fasthtml_auth-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fasthtml_auth-0.1.0.dist-info/top_level.txt,sha256=uG6b_v5AONQHyoez8FVziIAf9ORW0Ri_mUaU0yNwMWk,14
+fasthtml_auth-0.1.0.dist-info/RECORD,,

fasthtml_auth-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fasthtml_auth-0.1.0.dist-info/licenses/LICENSE

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

fasthtml_auth-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+fasthtml_auth