Metadata-Version: 2.1
Name: django-form-error-reporting
Version: 0.11
Summary: A form mixin that reports form errors as events to Google Analytics
Home-page: https://github.com/ministryofjustice/django-form-error-reporting
Author: Ministry of Justice Digital & Technology
Author-email: dev@digital.justice.gov.uk
License: MIT
Keywords: django form errors google-analytics
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
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
Requires-Python: >=3.6
License-File: LICENSE.txt

Django Form Error Reporting
===========================

A form mixin that reports form errors as events to Google Analytics.

NB: Only Universal Analytics is supported, which is now deprecated!

Usage
-----

Install using ``pip install django-form-error-reporting``.

See examples in tests/forms.py

.. code-block:: python

    class ReportedForm(GAErrorReportingMixin, Form):
        ga_tracking_id = 'UA-12345678-0'

        ...

Development
-----------

.. image:: https://github.com/ministryofjustice/django-form-error-reporting/actions/workflows/test.yml/badge.svg?branch=main
    :target: https://github.com/ministryofjustice/django-form-error-reporting/actions/workflows/test.yml

.. image:: https://github.com/ministryofjustice/django-form-error-reporting/actions/workflows/lint.yml/badge.svg?branch=main
    :target: https://github.com/ministryofjustice/django-form-error-reporting/actions/workflows/lint.yml

Please report bugs and open pull requests on `GitHub`_.

Use ``python setup.py test`` to run all tests.

Distribute a new version to `PyPi`_ by updating the ``version`` argument in ``setup.py:setup`` and
publishing a release in GitHub (this triggers a GitHub Actions workflow to automatically upload it).
Alternatively, run ``python setup.py sdist bdist_wheel upload`` locally.
Remember to update `History`_.


History
-------

0.11
    Warn that only Universal Analytics is supported at present.
    Drop support for python 3.6 and 3.7.
    Add support for python 3.11.
    Add experimental support for Django versions 4.0 & 4.1.
    Improve testing and linting.

0.10
    Add support for python 3.9 and 3.10.
    Improve testing and linting.

0.9
    Drop support for python 3.5.
    Improve linting.

0.8
    Drop python 2 support (now compatible with 3.5 - 3.8).
    Support Django 2.2 - 3.2 (both LTS).

0.7
    Improve testing.

0.6
    Fix versioning problem (module cannot be loaded until dependencies are installed).

0.5
    Report user language preference.
    Better IP address tracking for proxied requests.
    Add error logging for failed requests.
    Fix large payload bug.

0.4
    Ignore all errors when reporting to Google Analytics.

0.3
    Add python 2 compatibility.

0.2
    Add convenience form mixin to get Google Analytics ids from request and settings.

0.1
    Original release.

Copyright
---------

Copyright (C) 2023 HM Government (Ministry of Justice Digital & Technology).
See LICENSE.txt for further details.

.. _GitHub: https://github.com/ministryofjustice/django-form-error-reporting
.. _PyPi: https://pypi.org/project/django-form-error-reporting/
