drf-commons 1.0.0__tar.gz

drf_commons-1.0.0/.flake8

@@ -0,0 +1,22 @@
+[flake8]
+max-line-length = 88
+extend-ignore =
+    # E203: whitespace before ':'
+    E203,
+    # W503: line break before binary operator
+    W503,
+    # E501: line too long (let black handle this)
+    E501
+exclude =
+    .git,
+    __pycache__,
+    .venv,
+    venv,
+    env,
+    migrations,
+    build,
+    dist,
+    *.egg-info
+per-file-ignores =
+    # F401: imported but unused
+    __init__.py:F401

drf_commons-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Victoire HABAMUNGU
+
+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.

drf_commons-1.0.0/MANIFEST.in

@@ -0,0 +1,27 @@
+# Include documentation
+include README.md
+include LICENSE
+include requirements.txt
+
+# Include configuration files
+include pyproject.toml
+include setup.py
+include .flake8
+
+# Include all package data
+recursive-include drf_commons *.py
+recursive-include drf_commons/templates *
+recursive-include drf_commons/static *
+
+# Exclude unnecessary files
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * .DS_Store
+recursive-exclude * *.so
+recursive-exclude * *.dylib
+exclude .coverage
+exclude htmlcov
+exclude .gitignore
+recursive-exclude tests *
+recursive-exclude htmlcov *
+recursive-exclude .pytest_cache *

drf_commons-1.0.0/PKG-INFO

@@ -0,0 +1,323 @@
+Metadata-Version: 2.4
+Name: drf-commons
+Version: 1.0.0
+Summary: Django REST Framework Common Utilities - Modular apps for enhanced DRF functionality
+Author: Victoire HABAMUNGU
+Author-email: Victoire HABAMUNGU <contact@htvictoire.me>
+License: MIT
+Project-URL: Homepage, https://github.com/htvictoire/drf-common
+Project-URL: Repository, https://github.com/htvictoire/drf-common
+Project-URL: Issues, https://github.com/htvictoire/drf-common/issues
+Keywords: django,rest-framework,drf,utilities,api
+Classifier: Development Status :: 4 - Beta
+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.13
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=3.2
+Requires-Dist: djangorestframework>=3.12
+Provides-Extra: current-user
+Provides-Extra: debug
+Provides-Extra: filters
+Provides-Extra: pagination
+Provides-Extra: response
+Provides-Extra: serializers
+Provides-Extra: views
+Provides-Extra: export
+Requires-Dist: openpyxl>=3.0; extra == "export"
+Requires-Dist: weasyprint>=60.0; extra == "export"
+Provides-Extra: import
+Requires-Dist: openpyxl>=3.0; extra == "import"
+Requires-Dist: pandas>=1.3; extra == "import"
+Provides-Extra: config
+Requires-Dist: django-constance>=2.9; extra == "config"
+Provides-Extra: all
+Requires-Dist: openpyxl>=3.0; extra == "all"
+Requires-Dist: weasyprint>=60.0; extra == "all"
+Requires-Dist: pandas>=1.3; extra == "all"
+Requires-Dist: django-constance>=2.9; extra == "all"
+Provides-Extra: dev
+Requires-Dist: black==25.1.0; extra == "dev"
+Requires-Dist: flake8==7.3.0; extra == "dev"
+Requires-Dist: isort==6.0.1; extra == "dev"
+Requires-Dist: mypy==1.18.1; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest==8.4.2; extra == "test"
+Requires-Dist: pytest-cov==7.0.0; extra == "test"
+Requires-Dist: pytest-django==4.11.1; extra == "test"
+Requires-Dist: factory-boy>=3.3; extra == "test"
+Provides-Extra: build
+Requires-Dist: build>=1.0; extra == "build"
+Requires-Dist: twine>=6.0; extra == "build"
+Dynamic: author
+Dynamic: license-file
+Dynamic: requires-python
+
+# DRF Commons
+
+> **⚠️ UNDER DEVELOPMENT**: This library is currently under active development. APIs may change, and some features may not be fully stable yet.
+
+A comprehensive collection of reusable Django REST Framework utilities and components designed to accelerate API development.
+
+## Features
+
+### Core Modules
+
+- **Current User**: Middleware and utilities for accessing the current user context
+- **Debug**: Advanced logging and debugging tools with categorized loggers
+- **Decorators**: Performance monitoring, caching, database optimization, and logging decorators
+- **Filters**: Enhanced filtering and ordering capabilities including computed fields
+- **Middlewares**: Current user tracking and debug middleware
+- **Models**: Base models, mixins, and custom fields for common patterns
+- **Pagination**: Flexible pagination classes
+- **Response**: Standardized API response utilities
+- **Serializers**: Enhanced serializers with custom fields and mixins
+- **Views**: ViewSet mixins for CRUD, bulk operations, and import/export
+
+### Services
+
+- **Export File**: Export data to CSV, XLSX, and PDF formats
+- **Import from File**: Robust file import with validation and bulk operations
+
+## Installation
+
+Install the base package:
+
+```bash
+pip install drf-commons
+```
+
+Install with specific features:
+
+```bash
+# For export functionality (XLSX and PDF)
+pip install drf-commons[export]
+
+# For import functionality
+pip install drf-commons[import]
+
+# For dynamic configuration
+pip install drf-commons[config]
+
+# For all features
+pip install drf-commons[all]
+
+# For development
+pip install drf-commons[dev,test]
+```
+
+## Quick Start
+
+### 1. Add to INSTALLED_APPS
+
+```python
+INSTALLED_APPS = [
+    # ... your apps
+    'drf_commons.current_user',
+    'drf_commons.debug',
+    'drf_commons.filters',
+    'drf_commons.pagination',
+    'drf_commons.response',
+    'drf_commons.serializers',
+    'drf_commons.views',
+]
+```
+
+### 2. Add Middleware (Optional)
+
+```python
+MIDDLEWARE = [
+    # ... other middleware
+    'drf_commons.middlewares.current_user.CurrentUserMiddleware',
+    'drf_commons.middlewares.debug.DebugMiddleware',
+]
+```
+
+### 3. Use in Your Code
+
+```python
+from drf_commons.views.base import BaseViewSet
+from drf_commons.serializers.base import BaseSerializer
+from drf_commons.models.base import BaseModel
+from drf_commons.pagination.base import CustomPageNumberPagination
+
+class MyModel(BaseModel):
+    # Your model fields
+    pass
+
+class MySerializer(BaseSerializer):
+    class Meta:
+        model = MyModel
+        fields = '__all__'
+
+class MyViewSet(BaseViewSet):
+    queryset = MyModel.objects.all()
+    serializer_class = MySerializer
+    pagination_class = CustomPageNumberPagination
+```
+
+## Usage Examples
+
+### Export Data
+
+```python
+from drf_commons.services import ExportService
+
+service = ExportService()
+
+# Export to CSV (no optional dependencies required)
+response = service.export_csv(
+    data_rows=data,
+    includes=['id', 'name', 'created_at'],
+    column_config={},
+    filename='export.csv',
+    export_headers=[],
+    document_titles=[]
+)
+
+# Export to XLSX (requires openpyxl)
+response = service.export_xlsx(...)
+
+# Export to PDF (requires weasyprint)
+response = service.export_pdf(...)
+```
+
+### Import Data
+
+```python
+from drf_commons.services import FileImportService
+
+config = {
+    'model': MyModel,
+    'fields': {
+        'name': {'required': True},
+        'email': {'required': True, 'unique': True},
+    }
+}
+
+service = FileImportService(config)
+result = service.import_file(file_path)
+```
+
+### Use Decorators
+
+```python
+from drf_commons.decorators.performance import measure_performance
+from drf_commons.decorators.cache import cached_method
+
+class MyViewSet(BaseViewSet):
+    @measure_performance
+    @cached_method(timeout=300)
+    def expensive_operation(self):
+        # Your expensive operation
+        pass
+```
+
+## Requirements
+
+- Python >= 3.8
+- Django >= 3.2
+- djangorestframework >= 3.12
+
+## Optional Dependencies
+
+Different features require different dependencies:
+
+### Core Package (No optional dependencies)
+
+The base installation includes:
+
+- Models, Serializers, Views, Pagination, Response utilities
+- CSV export (no additional dependencies required)
+- Filters, Decorators, Middleware
+
+### File Export (`[export]`)
+
+For XLSX and PDF export functionality:
+
+- `openpyxl >= 3.0` - Excel (XLSX) export
+- `weasyprint >= 60.0` - PDF export
+
+### File Import (`[import]`)
+
+For importing data from CSV and Excel files:
+
+- `pandas >= 1.3` - Data processing and file parsing
+- `openpyxl >= 3.0` - Excel file reading
+
+### Dynamic Configuration (`[config]`)
+
+For runtime configuration management:
+
+- `django-constance >= 2.9` - Dynamic Django settings
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/drf-common.git
+cd drf-common
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode with all dependencies
+pip install -e .[dev,test,all]
+```
+
+### Run Tests
+
+```bash
+pytest
+```
+
+### Code Quality
+
+```bash
+# Format code
+black .
+
+# Sort imports
+isort .
+
+# Lint
+flake8
+
+# Type checking
+mypy drf_commons
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License.
+
+## Author
+
+Victoire HABAMUNGU
+
+## Support
+
+For issues and questions, please use the GitHub issue tracker.

drf_commons-1.0.0/README.md

@@ -0,0 +1,252 @@
+# DRF Commons
+
+> **⚠️ UNDER DEVELOPMENT**: This library is currently under active development. APIs may change, and some features may not be fully stable yet.
+
+A comprehensive collection of reusable Django REST Framework utilities and components designed to accelerate API development.
+
+## Features
+
+### Core Modules
+
+- **Current User**: Middleware and utilities for accessing the current user context
+- **Debug**: Advanced logging and debugging tools with categorized loggers
+- **Decorators**: Performance monitoring, caching, database optimization, and logging decorators
+- **Filters**: Enhanced filtering and ordering capabilities including computed fields
+- **Middlewares**: Current user tracking and debug middleware
+- **Models**: Base models, mixins, and custom fields for common patterns
+- **Pagination**: Flexible pagination classes
+- **Response**: Standardized API response utilities
+- **Serializers**: Enhanced serializers with custom fields and mixins
+- **Views**: ViewSet mixins for CRUD, bulk operations, and import/export
+
+### Services
+
+- **Export File**: Export data to CSV, XLSX, and PDF formats
+- **Import from File**: Robust file import with validation and bulk operations
+
+## Installation
+
+Install the base package:
+
+```bash
+pip install drf-commons
+```
+
+Install with specific features:
+
+```bash
+# For export functionality (XLSX and PDF)
+pip install drf-commons[export]
+
+# For import functionality
+pip install drf-commons[import]
+
+# For dynamic configuration
+pip install drf-commons[config]
+
+# For all features
+pip install drf-commons[all]
+
+# For development
+pip install drf-commons[dev,test]
+```
+
+## Quick Start
+
+### 1. Add to INSTALLED_APPS
+
+```python
+INSTALLED_APPS = [
+    # ... your apps
+    'drf_commons.current_user',
+    'drf_commons.debug',
+    'drf_commons.filters',
+    'drf_commons.pagination',
+    'drf_commons.response',
+    'drf_commons.serializers',
+    'drf_commons.views',
+]
+```
+
+### 2. Add Middleware (Optional)
+
+```python
+MIDDLEWARE = [
+    # ... other middleware
+    'drf_commons.middlewares.current_user.CurrentUserMiddleware',
+    'drf_commons.middlewares.debug.DebugMiddleware',
+]
+```
+
+### 3. Use in Your Code
+
+```python
+from drf_commons.views.base import BaseViewSet
+from drf_commons.serializers.base import BaseSerializer
+from drf_commons.models.base import BaseModel
+from drf_commons.pagination.base import CustomPageNumberPagination
+
+class MyModel(BaseModel):
+    # Your model fields
+    pass
+
+class MySerializer(BaseSerializer):
+    class Meta:
+        model = MyModel
+        fields = '__all__'
+
+class MyViewSet(BaseViewSet):
+    queryset = MyModel.objects.all()
+    serializer_class = MySerializer
+    pagination_class = CustomPageNumberPagination
+```
+
+## Usage Examples
+
+### Export Data
+
+```python
+from drf_commons.services import ExportService
+
+service = ExportService()
+
+# Export to CSV (no optional dependencies required)
+response = service.export_csv(
+    data_rows=data,
+    includes=['id', 'name', 'created_at'],
+    column_config={},
+    filename='export.csv',
+    export_headers=[],
+    document_titles=[]
+)
+
+# Export to XLSX (requires openpyxl)
+response = service.export_xlsx(...)
+
+# Export to PDF (requires weasyprint)
+response = service.export_pdf(...)
+```
+
+### Import Data
+
+```python
+from drf_commons.services import FileImportService
+
+config = {
+    'model': MyModel,
+    'fields': {
+        'name': {'required': True},
+        'email': {'required': True, 'unique': True},
+    }
+}
+
+service = FileImportService(config)
+result = service.import_file(file_path)
+```
+
+### Use Decorators
+
+```python
+from drf_commons.decorators.performance import measure_performance
+from drf_commons.decorators.cache import cached_method
+
+class MyViewSet(BaseViewSet):
+    @measure_performance
+    @cached_method(timeout=300)
+    def expensive_operation(self):
+        # Your expensive operation
+        pass
+```
+
+## Requirements
+
+- Python >= 3.8
+- Django >= 3.2
+- djangorestframework >= 3.12
+
+## Optional Dependencies
+
+Different features require different dependencies:
+
+### Core Package (No optional dependencies)
+
+The base installation includes:
+
+- Models, Serializers, Views, Pagination, Response utilities
+- CSV export (no additional dependencies required)
+- Filters, Decorators, Middleware
+
+### File Export (`[export]`)
+
+For XLSX and PDF export functionality:
+
+- `openpyxl >= 3.0` - Excel (XLSX) export
+- `weasyprint >= 60.0` - PDF export
+
+### File Import (`[import]`)
+
+For importing data from CSV and Excel files:
+
+- `pandas >= 1.3` - Data processing and file parsing
+- `openpyxl >= 3.0` - Excel file reading
+
+### Dynamic Configuration (`[config]`)
+
+For runtime configuration management:
+
+- `django-constance >= 2.9` - Dynamic Django settings
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/drf-common.git
+cd drf-common
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode with all dependencies
+pip install -e .[dev,test,all]
+```
+
+### Run Tests
+
+```bash
+pytest
+```
+
+### Code Quality
+
+```bash
+# Format code
+black .
+
+# Sort imports
+isort .
+
+# Lint
+flake8
+
+# Type checking
+mypy drf_commons
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License.
+
+## Author
+
+Victoire HABAMUNGU
+
+## Support
+
+For issues and questions, please use the GitHub issue tracker.

drf_commons-1.0.0/drf_commons/__init__.py

@@ -0,0 +1,7 @@
+"""
+Django REST Framework Common Utilities.
+
+A collection of reusable utilities and components for Django REST Framework applications.
+"""
+
+__version__ = "1.0.0"