Metadata-Version: 2.1
Name: django_auto_prefetching
Version: 0.1.8
Summary: Tools for automatically prefetching related objects in Django and Django-rest-framework
Home-page: https://github.com/GeeWee/django-auto-prefetching
Author: Gustav Wengel
Author-email: gustavwengel@gmail.com
License: MIT
Description: 
        
        # Django Auto-Prefetching
        *Never worry about n+1 performance problems again*
        
        This project aims to automatically perform the correct `select_related` and `prefetch_related`
        calls for your django-rest-framework code. It does this by inspecting your serializers, seeing what fields
        they use, and what models they refer to, and automatically calculating what needs to be prefetched.
        
        ## Installation
        `pip install django-auto-prefetching`
        
        ## AutoPrefetchViewSetMixin
        This is a ViewSet mixin you can use, which will automatically prefetch the needed objects from the database.
        In most circumstances this will be all the database optimizations you'll ever need to do:
        
        ### Usage
        Simply add it after your ModelViewSet class.
        
        ```python
        from django_auto_prefetching import AutoPrefetchViewSetMixin
        from rest_framework.viewsets import ModelViewSet
        
        class BaseModelViewSet(AutoPrefetchViewSetMixin, ModelViewSet):
            queryset = YourModel.objects.all()
            serializer_class = YourModelSerializer
        ```
        It supports all types of relational fields, (many to many, one to many, one to one, etc.) out of the box.
        
        ### Limitations
        The `AutoPrefetchViewSetMixin` cannot see what objects are being accessed in e.g. a `SerializerMethodField`.
        If you use objects in there, you might need to do some additional prefetches.
        
        ```python
        from django_auto_prefetching import AutoPrefetchViewSetMixin
        from rest_framework.viewsets import ModelViewSet
        
        class BaseModelViewSet(AutoPrefetchViewSetMixin, ModelViewSet):
            serializer_class = YourModelSerializer
            
            def get_queryset(self):
                    # Simply do the extra select_related / prefetch_related here
                    # and leave the mixin to do the rest of the work
                    queryset = YourModel.objects.all()
                    queryset = queryset.select_related('my_extra_field')
                    return queryset
        
        ```
        
        ## Supported Versions
        Currently the project is only being tested against the latest version of Python (3.7) and the latest version of Django(2.2)
        Pull Requests to support earlier versions of Django are welcome.
        
        ## Maturity
        The project is currently being used without issues in a medium-sized Django project(20.000 lines of code)
        
        ## Contributing
        Contributions are welcome! To get the tests running, do the following:
        - Clone the repository.
        - If you don't have it, install [pipenv](https://docs.pipenv.org/en/latest/install/#installing-pipenv)
        - Install the dependencies with `pipenv sync --dev`
        - Activate the virtualenv created by pipenv by writing `pipenv shell`
        - Run the tests with `./manage.py test`   
        
        # LICENSE:
        MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.9
Description-Content-Type: text/markdown
Provides-Extra: Rest framework integration
