crudadmin 0.1.0__tar.gz

crudadmin-0.1.0/LICENSE

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

crudadmin-0.1.0/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.1
+Name: crudadmin
+Version: 0.1.0
+Summary: FastAPI-based admin interface with authentication, event logging and CRUD operations
+Author-Email: Igor Benav <igor.magalhaes.r@gmail.com>
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Pydantic
+Classifier: Framework :: Pydantic :: 2
+Classifier: Intended Audience :: Developers
+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: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://github.com/igorbenav/crudadmin
+Project-URL: Documentation, https://igorbenav.github.io/crudadmin
+Project-URL: Repository, https://github.com/igorbenav/crudadmin
+Project-URL: Issues, https://github.com/igorbenav/crudadmin/issues
+Project-URL: Changelog, https://github.com/igorbenav/crudadmin/releases
+Requires-Python: >=3.9
+Requires-Dist: bcrypt>=4.2.1
+Requires-Dist: fastapi>=0.115.6
+Requires-Dist: fastcrud>=0.15.5
+Requires-Dist: jinja2>=3.1.5
+Requires-Dist: pydantic[email]>=2.10.4
+Requires-Dist: python-jose>=3.3.0
+Requires-Dist: python-multipart>=0.0.20
+Requires-Dist: sqlalchemy>=2.0.36
+Requires-Dist: user-agents>=2.2.0
+Requires-Dist: aiosqlite>=0.20.0
+Requires-Dist: greenlet>=3.1.1
+Provides-Extra: standard
+Requires-Dist: uvicorn[standard]>=0.12.0; extra == "standard"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3.4; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.25.3; extra == "dev"
+Requires-Dist: testcontainers[postgresql]>=4.9.1; extra == "dev"
+Requires-Dist: ruff>=0.9.3; extra == "dev"
+Requires-Dist: mypy>=1.9.0; extra == "dev"
+Requires-Dist: httptools>=0.6.4; extra == "dev"
+Requires-Dist: httpx>=0.28.1; extra == "dev"
+Requires-Dist: sqlalchemy[mypy]>=2.0.36; extra == "dev"
+Requires-Dist: sqlalchemy-utils>=0.41.2; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.6.1; extra == "docs"
+Requires-Dist: mkdocs-meta-descriptions-plugin>=4.0.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.6.1; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.27.0; extra == "docs"
+Provides-Extra: all
+Requires-Dist: crudadmin[dev,docs,standard]; extra == "all"
+Description-Content-Type: text/markdown
+
+# CRUDAdmin
+
+<p align="center">
+  <a href="https://igorbenav.github.io/crudadmin/">
+    <img src="docs/assets/CRUDAdmin.png" alt="CRUDAdmin logo" width="45%" height="auto">
+  </a>
+</p>
+
+<p align="center">
+  <i>Modern admin interface for FastAPI with built-in authentication, event tracking, and security features</i>
+</p>
+
+<p align="center">
+<a href="https://pypi.org/project/crudadmin">
+  <img src="https://img.shields.io/pypi/v/crudadmin?color=%2334D058&label=pypi%20package" alt="Package version"/>
+</a>
+<a href="https://pypi.org/project/crudadmin">
+  <img src="https://img.shields.io/pypi/pyversions/crudadmin.svg?color=%2334D058" alt="Supported Python versions"/>
+</a>
+</p>
+
+<hr>
+<p align="justify">
+<b>CRUDAdmin</b> is a robust admin interface generator for <b>FastAPI</b> applications, offering secure authentication, comprehensive event tracking, and essential monitoring features. Built on top of FastCRUD and SQLAlchemy, it helps you create production-ready admin panels with minimal configuration.
+</p>
+
+<p><b>Documentation</b>: <a href="https://igorbenav.github.io/crudadmin/">https://igorbenav.github.io/crudadmin/</a></p>
+
+<hr>
+
+## Features
+
+- 🔒 **Session-based Authentication**: Secure session management with inactivity timeouts and concurrent session limits
+- 🛡️ **Built-in Security**: IP restrictions, HTTPS enforcement, and secure cookie handling
+- 📝 **Event Tracking**: Comprehensive audit logs for all admin actions with user attribution
+- 🏥 **Health Monitoring**: Real-time system status dashboard with key metrics
+- 📊 **Auto-generated Interface**: Creates admin UI directly from your SQLAlchemy models
+- 🔍 **Smart Filtering**: Type-aware field filtering and efficient search
+- 🌗 **Modern UI**: Clean interface with dark/light theme support
+
+## Requirements
+
+Before installing CRUDAdmin, ensure you have:
+
+- **FastAPI**: Latest version for the web framework
+- **SQLAlchemy**: Version 2.0+ for database operations
+- **Pydantic**: Version 2.0+ for data validation
+
+## Installing
+
+```sh
+pip install crudadmin
+```
+
+Or using poetry:
+
+```sh
+poetry add crudadmin
+```
+
+## Usage
+
+CRUDAdmin offers a straightforward way to create admin interfaces. Here's how to get started:
+
+### Define Your Models and Schemas
+
+**models.py**
+```python
+from sqlalchemy.orm import DeclarativeBase
+from sqlalchemy import Column, Integer, String
+
+class Base(DeclarativeBase):
+    pass
+
+class User(Base):
+    __tablename__ = "users"
+    id = Column(Integer, primary_key=True)
+    username = Column(String, unique=True)
+    email = Column(String)
+    role = Column(String)
+```
+
+**schemas.py**
+```python
+from pydantic import BaseModel, EmailStr
+
+class UserCreate(BaseModel):
+    username: str
+    email: EmailStr
+    role: str = "user"
+
+class UserUpdate(BaseModel):
+    email: EmailStr | None = None
+    role: str | None = None
+```
+
+### Set Up the Admin Interface
+
+**main.py**
+```python
+from contextlib import asynccontextmanager
+from fastapi import FastAPI
+from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
+from crudadmin import CRUDAdmin
+import os
+
+# Database setup
+engine = create_async_engine("sqlite+aiosqlite:///app.db")
+session = AsyncSession(engine)
+
+# Create admin interface
+admin = CRUDAdmin(
+    session=session,
+    SECRET_KEY=os.environ.get("ADMIN_SECRET_KEY"),
+    initial_admin={
+        "username": "admin",
+        "password": "secure_password123"
+    }
+)
+
+# Add models to admin
+admin.add_view(
+    model=User,
+    create_schema=UserCreate,
+    update_schema=UserUpdate,
+    allowed_actions={"view", "create", "update"}
+)
+
+# Setup FastAPI with proper initialization
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    # Initialize database tables
+    async with engine.begin() as conn:
+        await conn.run_sync(Base.metadata.create_all)
+    
+    # Initialize admin interface
+    await admin.initialize()
+    yield
+
+# Create and mount the app
+app = FastAPI(lifespan=lifespan)
+app.mount("/admin", admin.app)
+```
+
+### Enable Event Tracking
+
+```python
+admin = CRUDAdmin(
+    session=session,
+    SECRET_KEY=SECRET_KEY,
+    track_events=True,
+    admin_db_url="postgresql+asyncpg://user:pass@localhost/admin_logs"
+)
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    async with engine.begin() as conn:
+        await conn.run_sync(Base.metadata.create_all)
+    await admin.initialize()  # Creates event tracking tables
+    yield
+```
+
+### Configure Security Features
+
+```python
+admin = CRUDAdmin(
+    session=session,
+    SECRET_KEY=SECRET_KEY,
+    # Security settings
+    allowed_ips=["10.0.0.1"],
+    allowed_networks=["192.168.1.0/24"],
+    secure_cookies=True,
+    enforce_https=True,
+    # Session settings
+    max_sessions_per_user=5,
+    session_timeout_minutes=30
+)
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    async with engine.begin() as conn:
+        await conn.run_sync(Base.metadata.create_all)
+    await admin.initialize()  # Initializes security features
+    yield
+```
+
+## Current Limitations (coming soon)
+
+- No file upload support yet
+- No custom admin views (model-based only)
+- No custom field widgets
+- No SQLAlchemy relationship support
+- No export functionality
+
+## Similar Projects
+
+- **[Django Admin](https://docs.djangoproject.com/en/stable/ref/contrib/admin/)**: The inspiration for this project
+- **[Flask-Admin](https://flask-admin.readthedocs.io/)**: Similar project for Flask
+- **[Sqladmin](https://github.com/aminalaee/sqladmin)**: Another FastAPI admin interface
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+Igor Benav – [@igorbenav](https://x.com/igorbenav) – igormagalhaesr@gmail.com
+[github.com/igorbenav](https://github.com/igorbenav/)

crudadmin-0.1.0/README.md

@@ -0,0 +1,208 @@
+# CRUDAdmin
+
+<p align="center">
+  <a href="https://igorbenav.github.io/crudadmin/">
+    <img src="docs/assets/CRUDAdmin.png" alt="CRUDAdmin logo" width="45%" height="auto">
+  </a>
+</p>
+
+<p align="center">
+  <i>Modern admin interface for FastAPI with built-in authentication, event tracking, and security features</i>
+</p>
+
+<p align="center">
+<a href="https://pypi.org/project/crudadmin">
+  <img src="https://img.shields.io/pypi/v/crudadmin?color=%2334D058&label=pypi%20package" alt="Package version"/>
+</a>
+<a href="https://pypi.org/project/crudadmin">
+  <img src="https://img.shields.io/pypi/pyversions/crudadmin.svg?color=%2334D058" alt="Supported Python versions"/>
+</a>
+</p>
+
+<hr>
+<p align="justify">
+<b>CRUDAdmin</b> is a robust admin interface generator for <b>FastAPI</b> applications, offering secure authentication, comprehensive event tracking, and essential monitoring features. Built on top of FastCRUD and SQLAlchemy, it helps you create production-ready admin panels with minimal configuration.
+</p>
+
+<p><b>Documentation</b>: <a href="https://igorbenav.github.io/crudadmin/">https://igorbenav.github.io/crudadmin/</a></p>
+
+<hr>
+
+## Features
+
+- 🔒 **Session-based Authentication**: Secure session management with inactivity timeouts and concurrent session limits
+- 🛡️ **Built-in Security**: IP restrictions, HTTPS enforcement, and secure cookie handling
+- 📝 **Event Tracking**: Comprehensive audit logs for all admin actions with user attribution
+- 🏥 **Health Monitoring**: Real-time system status dashboard with key metrics
+- 📊 **Auto-generated Interface**: Creates admin UI directly from your SQLAlchemy models
+- 🔍 **Smart Filtering**: Type-aware field filtering and efficient search
+- 🌗 **Modern UI**: Clean interface with dark/light theme support
+
+## Requirements
+
+Before installing CRUDAdmin, ensure you have:
+
+- **FastAPI**: Latest version for the web framework
+- **SQLAlchemy**: Version 2.0+ for database operations
+- **Pydantic**: Version 2.0+ for data validation
+
+## Installing
+
+```sh
+pip install crudadmin
+```
+
+Or using poetry:
+
+```sh
+poetry add crudadmin
+```
+
+## Usage
+
+CRUDAdmin offers a straightforward way to create admin interfaces. Here's how to get started:
+
+### Define Your Models and Schemas
+
+**models.py**
+```python
+from sqlalchemy.orm import DeclarativeBase
+from sqlalchemy import Column, Integer, String
+
+class Base(DeclarativeBase):
+    pass
+
+class User(Base):
+    __tablename__ = "users"
+    id = Column(Integer, primary_key=True)
+    username = Column(String, unique=True)
+    email = Column(String)
+    role = Column(String)
+```
+
+**schemas.py**
+```python
+from pydantic import BaseModel, EmailStr
+
+class UserCreate(BaseModel):
+    username: str
+    email: EmailStr
+    role: str = "user"
+
+class UserUpdate(BaseModel):
+    email: EmailStr | None = None
+    role: str | None = None
+```
+
+### Set Up the Admin Interface
+
+**main.py**
+```python
+from contextlib import asynccontextmanager
+from fastapi import FastAPI
+from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
+from crudadmin import CRUDAdmin
+import os
+
+# Database setup
+engine = create_async_engine("sqlite+aiosqlite:///app.db")
+session = AsyncSession(engine)
+
+# Create admin interface
+admin = CRUDAdmin(
+    session=session,
+    SECRET_KEY=os.environ.get("ADMIN_SECRET_KEY"),
+    initial_admin={
+        "username": "admin",
+        "password": "secure_password123"
+    }
+)
+
+# Add models to admin
+admin.add_view(
+    model=User,
+    create_schema=UserCreate,
+    update_schema=UserUpdate,
+    allowed_actions={"view", "create", "update"}
+)
+
+# Setup FastAPI with proper initialization
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    # Initialize database tables
+    async with engine.begin() as conn:
+        await conn.run_sync(Base.metadata.create_all)
+    
+    # Initialize admin interface
+    await admin.initialize()
+    yield
+
+# Create and mount the app
+app = FastAPI(lifespan=lifespan)
+app.mount("/admin", admin.app)
+```
+
+### Enable Event Tracking
+
+```python
+admin = CRUDAdmin(
+    session=session,
+    SECRET_KEY=SECRET_KEY,
+    track_events=True,
+    admin_db_url="postgresql+asyncpg://user:pass@localhost/admin_logs"
+)
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    async with engine.begin() as conn:
+        await conn.run_sync(Base.metadata.create_all)
+    await admin.initialize()  # Creates event tracking tables
+    yield
+```
+
+### Configure Security Features
+
+```python
+admin = CRUDAdmin(
+    session=session,
+    SECRET_KEY=SECRET_KEY,
+    # Security settings
+    allowed_ips=["10.0.0.1"],
+    allowed_networks=["192.168.1.0/24"],
+    secure_cookies=True,
+    enforce_https=True,
+    # Session settings
+    max_sessions_per_user=5,
+    session_timeout_minutes=30
+)
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    async with engine.begin() as conn:
+        await conn.run_sync(Base.metadata.create_all)
+    await admin.initialize()  # Initializes security features
+    yield
+```
+
+## Current Limitations (coming soon)
+
+- No file upload support yet
+- No custom admin views (model-based only)
+- No custom field widgets
+- No SQLAlchemy relationship support
+- No export functionality
+
+## Similar Projects
+
+- **[Django Admin](https://docs.djangoproject.com/en/stable/ref/contrib/admin/)**: The inspiration for this project
+- **[Flask-Admin](https://flask-admin.readthedocs.io/)**: Similar project for Flask
+- **[Sqladmin](https://github.com/aminalaee/sqladmin)**: Another FastAPI admin interface
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+Igor Benav – [@igorbenav](https://x.com/igorbenav) – igormagalhaesr@gmail.com
+[github.com/igorbenav](https://github.com/igorbenav/)

crudadmin-0.1.0/crudadmin/__init__.py

@@ -0,0 +1,3 @@
+from .admin_interface.crud_admin import CRUDAdmin
+
+__all__ = ["CRUDAdmin"]