Metadata-Version: 2.1
Name: pytest-django-queries
Version: 1.0.0a3
Summary: Generate performance rapports from your django database performance tests.
Home-page: https://github.com/NyanKiyoshi/pytest-django-queries/
Author: NyanKiyoshi
Author-email: hello@vanille.bid
License: UNKNOWN
Description: <div align='center'>
          <h1>pytest-django-queries</h1>
          <p>Generate performance rapports from your django database performance tests
          (inspired by <a href='https://coverage.readthedocs.io/en/v4.5.x/'>coverage.py</a>).</p>
          <p>
            <a href='https://travis-ci.org/NyanKiyoshi/pytest-django-queries/'>
              <img src='https://travis-ci.org/NyanKiyoshi/pytest-django-queries.svg?branch=master' alt='Requirement Status' />
            </a>
            <a href='https://codecov.io/gh/NyanKiyoshi/pytest-django-queries'>
              <img src='https://codecov.io/gh/NyanKiyoshi/pytest-django-queries/branch/master/graph/badge.svg' alt='Coverage Status' />
            </a>
            <a href='https://pytest-django-queries.readthedocs.io/en/latest/?badge=latest'>
              <img src='https://readthedocs.org/projects/pytest-django-queries/badge/?version=latest' alt='Documentation Status' />
            </a>
            <a href='https://pypi.python.org/pypi/pytest-django-queries'>
              <img src='https://img.shields.io/pypi/v/pytest-django-queries.svg' alt='Version' />
            </a>
            <a href="https://pypi.org/project/pytest-django-queries/1.0.0a2/">
              <img src="https://img.shields.io/badge/pypi%20unstable-v1.0.0a2-FF0000.svg" alt="Latest Unstable on pypi">
            </a>
          </p>
          <p>
            <a href='https://github.com/NyanKiyoshi/pytest-django-queries/compare/v1.0.0a2...master'>
              <img src='https://img.shields.io/github/commits-since/NyanKiyoshi/pytest-django-queries/v1.0.0a2.svg' alt='Commits since latest release' />
            </a>
            <a href='https://pypi.python.org/pypi/pytest-django-queries'>
              <img src='https://img.shields.io/pypi/pyversions/pytest-django-queries.svg' alt='Supported versions' />
            </a>
            <a href='https://pypi.python.org/pypi/pytest-django-queries'>
              <img src='https://img.shields.io/pypi/implementation/pytest-django-queries.svg' alt='Supported implementations' />
            </a>
          </p>
        </div>
        
        ## Usage
        Install `pytest-django-queries`, write your pytest tests and mark any
        test that should be counted or use the `count_queries` fixture.
        
        Note: to use the latest development build, use `pip install --pre pytest-django-queries`
        
        ```python
        import pytest
        
        
        @pytest.mark.count_queries
        def test_query_performances():
            Model.objects.all()
        
        
        # Or...
        def test_another_query_performances(count_queries):
            Model.objects.all()
        ```
        
        Each test file and/or package is considered as a category. Each test inside a "category"
        compose its data, see [Visualising Results](#visualising-results) for more details.
        
        You will find the [full documentation here](https://pytest-django-queries.readthedocs.io/).
        
        <!-- TODO: insert a graphic here to explain how it works -->
        
        ## Integrating with GitHub
        
        ## Testing locally
        Simply install `pytest-django-queries` through pip and run your 
        tests using `pytest`. A report should have been generated in your
        current working directory in a file called with `.pytest-queries`.
        
        Note: to override the save path, pass the `--django-db-bench PATH` option to pytest.
        
        ## Visualising Results
        You can generate a table from the tests results by using the `show` command:
        ```shell
        django-queries show
        ```
        
        You will get something like this to represent the results:
        ```shell
        +---------+-------------------------+
        | Module  |          Tests          |
        +---------+-------------------------+
        | module1 | +-----------+---------+ |
        |         | | Test Name | Queries | |
        |         | +-----------+---------+ |
        |         | |   test1   |    0    | |
        |         | +-----------+---------+ |
        |         | |   test2   |    1    | |
        |         | +-----------+---------+ |
        +---------+-------------------------+
        | module2 | +-----------+---------+ |
        |         | | Test Name | Queries | |
        |         | +-----------+---------+ |
        |         | |   test1   |   123   | |
        |         | +-----------+---------+ |
        +---------+-------------------------+
        | module3 |                         |
        +---------+-------------------------+
        ```
        
        ## Exporting the results (HTML)
        For a nicer presentation, use the `html` command, to export the results as HTML.
        ```shell
        django-queries html > results.html
        ```
        <!-- todo: add example page link -->
        
        ## Comparing results
        
        ## Development
        First of all, clone the project locally. Then, install it using the below command.
        
        ```shell
        ./setup.py develop
        ```
        
        After that, you need to install the development requirements. For that, 
        run the below command.
        
        ```shell
        pip install -e .[dev]
        ```
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Framework :: Django
Classifier: Framework :: Pytest
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Provides-Extra: dev
