django-form-error-reporting


Namedjango-form-error-reporting JSON
Version 0.12 PyPI version JSON
download
home_pagehttps://github.com/ministryofjustice/django-form-error-reporting
SummaryA form mixin that reports form errors as events to Google Analytics
upload_time2023-11-16 15:32:54
maintainer
docs_urlNone
authorMinistry of Justice Digital & Technology
requires_python>=3.6
licenseMIT
keywords django form errors google analytics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Django Form Error Reporting
===========================

**DEPRECATED**: We have decided to not update this package to support GA4 and this is
no longer maintained.

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`_.

To work on changes to this library, it’s recommended to install it in editable mode into a virtual environment,
i.e. ``pip install --editable .``

Use ``python -m tests`` to run all tests locally.
Alternatively, you can use ``tox`` if you have multiple python versions.

[Only for GitHub team members] Distribute a new version to `PyPI`_ by:

- updating the ``VERSION`` tuple in ``form_error_reporting.py``
- adding a note to the `History`_
- publishing a release on GitHub which triggers an upload to PyPI;
  alternatively, run ``python -m build; twine upload dist/*`` locally

History
-------

0.12
    Migrated test, build and release processes away from deprecated setuptools commands.
    No significant library changes.

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/

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ministryofjustice/django-form-error-reporting",
    "name": "django-form-error-reporting",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "django form,errors,google analytics",
    "author": "Ministry of Justice Digital & Technology",
    "author_email": "dev@digital.justice.gov.uk",
    "download_url": "https://files.pythonhosted.org/packages/22/6b/db45f567749b751b1bda075fb7f9f38281a003629cdccd16b6bb9d49314b/django-form-error-reporting-0.12.tar.gz",
    "platform": null,
    "description": "Django Form Error Reporting\n===========================\n\n**DEPRECATED**: We have decided to not update this package to support GA4 and this is\nno longer maintained.\n\nA form mixin that reports form errors as events to Google Analytics.\n\nNB: Only Universal Analytics is supported, which is now deprecated!\n\nUsage\n-----\n\nInstall using ``pip install django-form-error-reporting``.\n\nSee examples in tests/forms.py\n\n.. code-block:: python\n\n    class ReportedForm(GAErrorReportingMixin, Form):\n        ga_tracking_id = 'UA-12345678-0'\n\n        ...\n\nDevelopment\n-----------\n\n.. image:: https://github.com/ministryofjustice/django-form-error-reporting/actions/workflows/test.yml/badge.svg?branch=main\n    :target: https://github.com/ministryofjustice/django-form-error-reporting/actions/workflows/test.yml\n\n.. image:: https://github.com/ministryofjustice/django-form-error-reporting/actions/workflows/lint.yml/badge.svg?branch=main\n    :target: https://github.com/ministryofjustice/django-form-error-reporting/actions/workflows/lint.yml\n\nPlease report bugs and open pull requests on `GitHub`_.\n\nTo work on changes to this library, it\u2019s recommended to install it in editable mode into a virtual environment,\ni.e. ``pip install --editable .``\n\nUse ``python -m tests`` to run all tests locally.\nAlternatively, you can use ``tox`` if you have multiple python versions.\n\n[Only for GitHub team members] Distribute a new version to `PyPI`_ by:\n\n- updating the ``VERSION`` tuple in ``form_error_reporting.py``\n- adding a note to the `History`_\n- publishing a release on GitHub which triggers an upload to PyPI;\n  alternatively, run ``python -m build; twine upload dist/*`` locally\n\nHistory\n-------\n\n0.12\n    Migrated test, build and release processes away from deprecated setuptools commands.\n    No significant library changes.\n\n0.11\n    Warn that only Universal Analytics is supported at present.\n    Drop support for python 3.6 and 3.7.\n    Add support for python 3.11.\n    Add experimental support for Django versions 4.0 & 4.1.\n    Improve testing and linting.\n\n0.10\n    Add support for python 3.9 and 3.10.\n    Improve testing and linting.\n\n0.9\n    Drop support for python 3.5.\n    Improve linting.\n\n0.8\n    Drop python 2 support (now compatible with 3.5 - 3.8).\n    Support Django 2.2 - 3.2 (both LTS).\n\n0.7\n    Improve testing.\n\n0.6\n    Fix versioning problem (module cannot be loaded until dependencies are installed).\n\n0.5\n    Report user language preference.\n    Better IP address tracking for proxied requests.\n    Add error logging for failed requests.\n    Fix large payload bug.\n\n0.4\n    Ignore all errors when reporting to Google Analytics.\n\n0.3\n    Add python 2 compatibility.\n\n0.2\n    Add convenience form mixin to get Google Analytics ids from request and settings.\n\n0.1\n    Original release.\n\nCopyright\n---------\n\nCopyright (C) 2023 HM Government (Ministry of Justice Digital & Technology).\nSee LICENSE.txt for further details.\n\n.. _GitHub: https://github.com/ministryofjustice/django-form-error-reporting\n.. _PyPI: https://pypi.org/project/django-form-error-reporting/\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A form mixin that reports form errors as events to Google Analytics",
    "version": "0.12",
    "project_urls": {
        "Homepage": "https://github.com/ministryofjustice/django-form-error-reporting"
    },
    "split_keywords": [
        "django form",
        "errors",
        "google analytics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e583e7c53793d4986616d7ae34fb1e56c5d4f72cf7afaa09689f56f7b5835584",
                "md5": "db91ad6a73c4d777995d705ee0bb02da",
                "sha256": "1e4a906788134f67233ae325a69a3a9cf69a3bda9db5822fdfad4fb80fabbc02"
            },
            "downloads": -1,
            "filename": "django_form_error_reporting-0.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "db91ad6a73c4d777995d705ee0bb02da",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 6171,
            "upload_time": "2023-11-16T15:32:52",
            "upload_time_iso_8601": "2023-11-16T15:32:52.314640Z",
            "url": "https://files.pythonhosted.org/packages/e5/83/e7c53793d4986616d7ae34fb1e56c5d4f72cf7afaa09689f56f7b5835584/django_form_error_reporting-0.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "226bdb45f567749b751b1bda075fb7f9f38281a003629cdccd16b6bb9d49314b",
                "md5": "6946ce8f51a6cd54744d34e550742b21",
                "sha256": "ea83aab7da052eb6db71df616d6080a90db87b5a30deb904cbbd4098cbc3af83"
            },
            "downloads": -1,
            "filename": "django-form-error-reporting-0.12.tar.gz",
            "has_sig": false,
            "md5_digest": "6946ce8f51a6cd54744d34e550742b21",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 7809,
            "upload_time": "2023-11-16T15:32:54",
            "upload_time_iso_8601": "2023-11-16T15:32:54.099972Z",
            "url": "https://files.pythonhosted.org/packages/22/6b/db45f567749b751b1bda075fb7f9f38281a003629cdccd16b6bb9d49314b/django-form-error-reporting-0.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-16 15:32:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ministryofjustice",
    "github_project": "django-form-error-reporting",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "django-form-error-reporting"
}
        
Elapsed time: 4.08111s