behave-django |latest-version|

|check-status| |test-status| |publish-status| |download-stats| |python-support| |docs-status| |discussions| |license|

Behave BDD integration for Django

.. features-marker

Features

• Web browser automation ready
• Database transactions per scenario
• Use Django's test client
• Use unittest + Django assert library
• Use behave's command line arguments
• Use behave's configuration file
• Fixture loading
• Page objects

.. support-marker

Version Support

behave-django is tested against_ the officially supported combinations of
Python and Django (Django 5.2, 6.0 on Python 3.10 through 3.14).

Installs the latest stable version of behave_ as a dependency.

.. docs-marker

Documentation

• Documentation is available from behave-django.readthedocs.io_
• Read more about behave at behave.readthedocs.io_

.. contribute-marker

How to Contribute

Please, read the contributing guide_ in the docs.

.. references-marker

.. _tested against: https://github.com/behave/behave-django/actions/workflows/test.yml
.. _behave: https://pypi.org/project/behave/
.. _behave-django.readthedocs.io: https://behave-django.readthedocs.io/en/latest/
.. _behave.readthedocs.io: https://behave.readthedocs.io/en/latest/usecase_django/
.. _contributing guide: https://behave-django.readthedocs.io/en/latest/contribute.html
.. |latest-version| image:: https://img.shields.io/pypi/v/behave-django.svg
:target: https://pypi.org/project/behave-django/
:alt: Latest version
.. |download-stats| image:: https://img.shields.io/pypi/dm/behave-django.svg
:alt: Monthly downloads from PyPI
:target: https://pypistats.org/packages/behave-django
.. |check-status| image:: https://github.com/behave/behave-django/actions/workflows/check.yml/badge.svg
:target: https://github.com/behave/behave-django/actions/workflows/check.yml
:alt: Code checks status
.. |test-status| image:: https://github.com/behave/behave-django/actions/workflows/test.yml/badge.svg
:target: https://github.com/behave/behave-django/actions/workflows/test.yml
:alt: Test suite status
.. |publish-status| image:: https://github.com/behave/behave-django/actions/workflows/publish.yml/badge.svg
:target: https://github.com/behave/behave-django/actions/workflows/publish.yml
:alt: Release status
.. |python-support| image:: https://img.shields.io/pypi/pyversions/behave-django.svg
:target: https://pypi.org/project/behave-django/
:alt: Python versions
.. |license| image:: https://img.shields.io/pypi/l/behave-django.svg
:target: https://github.com/behave/behave-django/blob/main/LICENSE
:alt: Software license
.. |docs-status| image:: https://img.shields.io/readthedocs/behave-django/stable.svg
:target: https://readthedocs.org/projects/behave-django/
:alt: Documentation Status
.. |discussions| image:: https://img.shields.io/github/discussions/behave/behave-django.svg
:alt: Discussions
:target: https://github.com/behave/behave-django/discussions