fabiplus 1.0.0

FABI+ Framework - Production-ready, modular, extensible API-only Python framework

FABI+ Framework

FABI+ (FastAPI + Django-like Admin Interface) is a modern Python web framework that combines the speed and flexibility of FastAPI with the convenience of Django-style admin interfaces and ORM patterns.

Documentation • Quick Start • Examples • Contributing

🚀 Features

🔥 Core Features

• FastAPI Backend: High-performance async API with automatic OpenAPI documentation
• Django-style Admin: Familiar admin interface with CRUD operations
• Multiple ORM Support: SQLModel and SQLAlchemy (Tortoise ORM planned for future release)
• Auto-generated APIs: Automatic CRUD endpoints for your models
• CLI Tools: Django-like management commands (startproject, startapp, migrate)

🔐 Authentication & Security

• OAuth2 + JWT: Built-in authentication with JWT tokens
• Role-based Permissions: Granular permissions with custom roles
• User Registration: Built-in user registration and management
• Security Headers: CORS, CSP, and other security features
• Rate Limiting: Built-in API rate limiting

🗄️ Database & ORM

• Database Migrations: Alembic integration for schema management
• Multiple Databases: PostgreSQL, MySQL, SQLite support
• Connection Pooling: Optimized database connections
• Query Optimization: Built-in query optimization and caching

🚀 Production Ready

• Docker Support: Ready-to-use Docker configurations
• Caching Support: Redis and in-memory caching
• Logging & Monitoring: Comprehensive logging and health checks
• Performance: Optimized for high-performance applications
• Scalability: Horizontal and vertical scaling support

📦 Installation

Using pip (Recommended)

pip install fabiplus

From source

git clone https://github.com/helevon/fabiplus.git
cd fabiplus
pip install -e .

Development installation

git clone https://github.com/helevon/fabiplus.git
cd fabiplus
pip install -e ".[dev]"

🏃‍♂️ Quick Start

1. Create a new project

fabiplus project startproject myblog
cd myblog

2. Create an app

fabiplus app startapp blog

3. Define your models

# apps/blog/models.py
from fabiplus.core.models import BaseModel, register_model
from sqlmodel import Field
from typing import Optional
import uuid

@register_model
class Post(BaseModel, table=True):
    """Blog post model"""
    
    title: str = Field(max_length=200, description="Post title")
    content: str = Field(description="Post content")
    excerpt: Optional[str] = Field(default="", description="Post excerpt")
    is_published: bool = Field(default=False, description="Is published")
    author_id: uuid.UUID = Field(foreign_key="user.id", description="Post author")
    
    class Config:
        _verbose_name = "Blog Post"
        _verbose_name_plural = "Blog Posts"
    
    def __str__(self):
        return self.title

4. Configure your app

# myblog/settings.py
INSTALLED_APPS = [
    "apps.core",
    "apps.blog",  # Add your app here
]

5. Run migrations

fabiplus db makemigrations
fabiplus db migrate

6. Create a superuser

fabiplus user create --username admin --email [e-mail] --password admin123 --superuser

7. Start the server

fabiplus server run

8. Access your application

• API Documentation: http://127.0.0.1:8000/docs
• Admin Interface: http://127.0.0.1:8000/admin
• API Endpoints: http://127.0.0.1:8000/api/v1/

🎯 Use Cases

FABI+ is perfect for:

• Blog Systems: Content management with authentication
• API Backends: RESTful APIs with automatic documentation
• Admin Dashboards: Data management interfaces
• E-commerce: Product catalogs and order management
• CMS Applications: Content management systems
• SaaS Applications: Multi-tenant applications with role-based access

📚 Documentation

• 📖 Full Documentation: fabiplus.helevon.org
• 🚀 Quick Start Guide: Getting Started
• 📋 API Reference: API Documentation
• 🔐 Authentication Guide: Authentication
• 🎨 Frontend Integration: Frontend Guide
• 🚀 Deployment: Production Deployment

🤝 Contributing

We welcome contributions from the community! FABI+ is open source and we encourage you to help make it better.

🌟 Ways to Contribute

• 🐛 Report Bugs: Create an issue
• 💡 Request Features: Feature requests
• 📝 Improve Documentation: Help us improve our docs
• 🔧 Submit Code: Fix bugs or add new features
• 🧪 Write Tests: Help us improve test coverage
• 💬 Join Discussions: GitHub Discussions

🛠️ Development Setup

1. Fork and clone the repository

   git clone https://github.com/yourusername/fabiplus.git
   cd fabiplus
   

2. Set up development environment

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   pip install -e ".[dev]"
   

3. Run tests

   pytest
   

4. Format code

   black fabiplus/
   isort fabiplus/
   

📋 Development Process

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Add tests for your changes
5. Run the test suite (pytest)
6. Format your code (black . && isort .)
7. Commit your changes (git commit -m 'Add amazing feature')
8. Push to the branch (git push origin feature/amazing-feature)
9. Open a Pull Request

🧪 Testing

We maintain high test coverage. Please add tests for any new features:

# Run all tests
pytest

# Run with coverage
pytest --cov=fabiplus

# Run specific test file
pytest tests/test_models.py

# Run with verbose output
pytest -v

📝 Code Style

We use Black and isort for code formatting:

# Format code
black fabiplus/ tests/
isort fabiplus/ tests/

# Check formatting
black --check fabiplus/ tests/
isort --check-only fabiplus/ tests/

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License Summary

• ✅ Commercial use - Use in commercial projects
• ✅ Modification - Modify the source code
• ✅ Distribution - Distribute the software
• ✅ Private use - Use privately
• ❌ Liability - No warranty or liability
• ❌ Warranty - No warranty provided

🙏 Acknowledgments

• FastAPI - For the excellent async framework
• Django - For admin interface inspiration
• SQLModel - For the modern ORM approach
• Pydantic - For data validation
• Alembic - For database migrations
• The Python Community - For amazing tools and libraries

🌟 Star History

📞 Support & Community

• 📖 Documentation: fabiplus.helevon.org
• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• 📧 Email: [e-mail]
• 🐦 Twitter: @helevon_org

---

Made with ❤️ by the Helevon team

⭐ Star us on GitHub • 🚀 Try the Demo • 📖 Read the Docs