Metadata-Version: 2.1
Name: django-trackings
Version: 0.1.1a0
Summary: A Django app that tracks your queries and helps optimizing them.
Home-page: https://github.com/tijani-dia/dj-tracker/
Author: Tidiane Dia
Author-email: atdia97@gmail.com
License: BSD-3-Clause
Project-URL: Documentation, https://tijani-dia.github.io/dj-tracker/
Project-URL: Source, https://github.com/tijani-dia/dj-tracker/
Project-URL: Issue tracker, https://github.com/tijani-dia/dj-tracker/issues/
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Django
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django (>=3.2)
Provides-Extra: build
Requires-Dist: twine ; extra == 'build'
Requires-Dist: check-wheel-contents ; extra == 'build'
Provides-Extra: docs
Requires-Dist: mkdocs ; extra == 'docs'
Requires-Dist: mkdocs-material ; extra == 'docs'
Provides-Extra: test
Requires-Dist: black ; extra == 'test'
Requires-Dist: isort ; extra == 'test'
Requires-Dist: flake8 ; extra == 'test'
Requires-Dist: factory-boy ; extra == 'test'
Requires-Dist: autoflake ; extra == 'test'

<p align="center">
<a href="https://github.com/tijani-dia/dj-tracker/actions/workflows/test.yml">
    <img src="https://github.com/tijani-dia/dj-tracker/actions/workflows/test.yml/badge.svg"/>
</a>
<a href="https://codecov.io/gh/Tijani-Dia/dj-tracker">
    <img src="https://codecov.io/gh/Tijani-Dia/dj-tracker/branch/main/graph/badge.svg?token=MKJ71ZJE67"/>
</a>
<a href="https://pypi.org/project/django-trackings/">
    <img src="https://badge.fury.io/py/django-trackings.svg" alt="Package version">
</a>
<a href="https://opensource.org/licenses/BSD-3-Clause">
    <img src="https://img.shields.io/badge/license-BSD-blue.svg"/>
</a>
</p>

# dj-tracker

`dj-tracker` is an app that tracks your queries to help detecting some possible performance optimisations listed in [Database access optimization](https://docs.djangoproject.com/en/dev/topics/db/optimization/).

## Features

-   Detailed field usage of model instances
-   Report unused fields in a model instance and provides hints on when to use `.defer` and `.only`
-   Report model instance attributes access and provides hints on when to use `.values` or `.values_list`
-   Report cache hits and provides hints on when to use `iterator`
-   Provides hints on when to use `.count`, `.contains`, `.exists`
-   Detect N+1 queries
-   Detect when a deferred field is loaded
-   and many more insights into your queries....

## Requirements

-   Python: `>=3.8`
-   Django: `>=3.2`

## Getting started

Check out the [installation steps](https://tijani-dia.github.io/dj-tracker/installation/).

## Documentation

All documentation is in the "docs" directory and online at https://tijani-dia.github.io/dj-tracker/
