Welcome to lback documentation!

lback is a modern and performant Python web framework designed with a focus on modularity, control, and developer experience. It offers a solid foundation for building a wide range of web applications, from simple APIs to complex, data-driven systems.

Key Features & Highlights:

• Modular & Organized Architecture: Enjoy a clean project structure inspired by popular frameworks like Django, making it easy to learn and scale with pluggable modules.

• Powerful CLI (`manage.py`): A comprehensive command-line interface to streamline project, app, database, and user management tasks.

• Flexible Configuration: Load settings effortlessly from settings.py, config.json, and environment variables (.env).

• Advanced Routing System: Define clean, dynamic URL patterns with support for path variables and modular URL inclusion.

• Robust Middleware Management: Process requests and responses seamlessly before and after they reach your views, with built-in Dependency Injection support.

• Strong ORM & Database Integration: Full ``SQLAlchemy``_ support for efficient data modeling and interaction with various databases.

• Automated Database Migrations: Manage database schema changes in an organized and automated way using ``Alembic``_.

• Comprehensive Authentication & Authorization: Built-in support for Session-based and ``JWT``_ authentication, complemented by a flexible permissions system.

• Efficient Templating: Leverage the powerful ``Jinja2``_ templating engine for dynamic and reusable HTML interface rendering.

• Smart Error Handling: Catch errors gracefully and generate appropriate responses, with a built-in detailed error reporting system for development.

• Essential Security Features: Tools to safeguard your application against common vulnerabilities such as CSRF, CORS, SQL Injection, and XSS. Includes Rate Limiting and Security Headers.

• Integrated Admin Panel: A ready-to-use administrative interface featuring a Dashboard and comprehensive user management.

• API Development Tools: Helper utilities for building robust APIs, including data serialization capabilities.

• Form Handling: Streamline the creation and validation of HTML forms.

• File Management: Efficiently serve and manage both Static Files (CSS, JavaScript, images) and user-uploaded Media Files.

• Signals System: Enable decoupled components to communicate by allowing them to get notified when specific actions occur elsewhere in the framework.

• Core Utilities: Handy helper functions for common tasks related to sessions, users, emails, and more.

• WSGI Support: Optimized and ready for seamless deployment on production WSGI servers.

• Integrated Testing: First-class support for ``Pytest``_ to facilitate writing and running robust application tests.

• Developer-Friendly Tools: Includes built-in Logging and Debugging tools for a smoother development workflow.

• Frontend Integration: Optional styling capabilities with ``Tailwind CSS``_ integration.

• Comprehensive Documentation: Detailed API reference and developer guides to help you get started and build effectively.

—

Getting Started

To get started with Lback, explore the following sections in order:

Contents:

• Installation
  • Requirements
  • Installation Steps
• Usage
  • Creating a New Project
  • App Management
  • Database Management & Migrations
  • Admin and User Management
  • Server and Development Utilities
• Configuration System
  • Core Project Settings
  • Database Configuration
  • Email (SMTP) Configuration
  • Logging Configuration
  • Path Definitions
  • Static Files Configuration
  • Media Files (User Uploads) Configuration
  • Installed Applications (Apps)
  • Middleware Configuration
  • Security Settings

—

Core Features

These sections cover the fundamental building blocks of an Lback application:

• Routing System
  • URL Including
• Views & Responses
• Templating System
  • How the render Shortcut Works
  • Example Template (course_list.html)
• Static Files
  • Configuration
  • Usage in Templates
• Media Files
  • Configuration
  • Usage in Templates
• File Uploads in Lback Framework
  • 1. How File Uploads Work in Lback
  • 2. File Upload Configuration Options in settings.py
  • 3. How to Handle Uploaded Files in Views
• Forms
  • 1- Defining Forms
  • 2- Form Lifecycle & Usage
  • 3- Field Types
  • 4. Widgets
  • 6- ModelForm

—

Data & Security

Learn how to manage your data and secure your application:

• Models & Database
• Database Migrations System
  • Migration Commands
  • Development Workflow
• Authentication
  • Quick Setup for Authentication
  • What the System Provides Automatically
  • Authentication Endpoints Reference
  • Web-based Authentication Endpoints
  • API Authentication Endpoints
• Authorization
  • 1. Permissions System: Role-Based Access Control (RBAC) for Standard Users
  • 2. Managing Permissions, Groups, and Users for Standard Users
  • 3. Admin User Permissions and Hierarchy
  • 4. Enforcing Authorization with PermissionRequired Decorator (General Usage)
  • How to Use:
  • 5. Permission Check Flow & Denied Access Handling
  • 6. Signals for Authorization Flow
• Sessions in Lback Framework
  • 1. Session Structure in the Database
  • 2. How Sessions Work in Lback
  • 3. Session Configuration Options in settings.py
  • 4. Accessing and Storing Session Data in Views
• Security Features
  • Security Settings

—

Advanced & Integration Features

Explore specialized functionalities and integration points:

• Built-in Admin Panel
  • 1. Accessing the Admin Panel
  • 2. Registering Your Models
  • 3. Admin Panel and ModelForm Integration
  • 4. Admin Panel and User Permissions
  • 5. Key Features and Customization
• API Tools
  • Serialization:
  • API Views & Generic Views:
  • API Documentation:
• Signal System
  • How to Use:
• Middleware System
  • Middleware Configuration
• Custom Middlewares
  • 1. Understanding Middleware
  • 2. The Middleware Protocol
  • 3. Creating a Custom Middleware
  • 4. Registering Your Custom Middleware
  • 5. Best Practices for Writing Middlewares
• Logging Configuration
  • Controlling Logging Level with DEBUG and LOGGING_LEVEL
  • Advanced Logging with LOGGING Dictionary
• Email Sending in Lback Framework
  • 1. The EmailSender Class
  • 2. Email Configuration in settings.py
  • 3. Using the EmailSender in Views (or other modules)
• Validation Utilities
  • 1. ValidationError Exception
  • 2. PasswordValidator
  • 3. JSON Data Validation (validate_json)
• Error Handling and HTTP Exceptions
  • 1. Base Exception Classes
  • 2. Common HTTP Exception Subclasses
  • 3. Raising and Handling Exceptions
• Error Handling & Reporting
  • How Error Handling Works
  • Debugging with Browser Error Reporting
  • Customizing Error Pages with Templates

—

Deployment

Instructions on how to deploy your Lback application to production:

• Deployment
  • Choosing a WSGI Server
  • Basic Deployment Example (Gunicorn)
  • Next Steps

—

Signals Reference

Detailed documentation for all signals emitted throughout the framework, categorized by component:

• Signals from BaseView
• Signals from APIDocs
• Signals from BaseModelSerializer
• Signals from AdminRegistry
• Signals from AdminUser and Role Models
• Signals from AdminUserManager
• Signals from AdminUserRepository
• Signals from AdminAuth
• Signals from JWTAuth
• Signals from OAuth2Auth
• Signals from PermissionRequired
• Signals from SessionAuth
• Signals from ErrorHandler
• Signals from MiddlewareManager
• Signals from MigrationCommands
• Signals from PermissionRepository
• Signals from RoleRepository
• Signals from SessionManager
• Signals from TemplateRenderer
• Signals from UserManager
• Signals from User Model
• Signals from UserRepository
• Signals from WSGI Application and Server

—

API Reference & Project Structure

Dive into the code and architecture of Lback:

• lback
• API Reference
  • Core
  • Auth App
  • Admin App
  • Middleware
  • Authentication
  • Forms
  • Models
  • API
  • Utilities
  • Commands
  • Repositories
  • Security
• lback package
  • Subpackages
  • Submodules
  • lback.main module

—

About

The lback documentation is maintained and authored by Ibrahem Abo Kila, providing developers with detailed guidance and references for building with the framework.

Author: Ibrahem Abo Kila

Email: ibrahemabokila@gmail.com

GitHub: https://github.com/hemaabokila/lback_framework

LinkedIn: https://www.linkedin.com/in/ibrahem-abo-kila/

YouTube: https://www.youtube.com/channel/UC…