====== behave

.. image:: https://github.com/behave/behave/actions/workflows/tests.yml/badge.svg :target: https://github.com/behave/behave/actions/workflows/tests.yml :alt: CI Build Status

.. image:: https://readthedocs.org/projects/behave/badge/?version=latest :target: https://behave.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/behave.svg :target: https://pypi.python.org/pypi/behave :alt: Latest Version

.. image:: https://img.shields.io/pypi/l/behave.svg :target: https://pypi.python.org/pypi/behave/ :alt: License

.. image:: https://badges.gitter.im/join_chat.svg :alt: Join the chat at https://gitter.im/behave/behave :target: https://app.gitter.im/#/room/#behave_behave:gitter.im

.. |logo| image:: https://raw.github.com/behave/behave/master/docs/_static/behave_logo1.png

behave is behavior-driven development, Python style.

|logo|

Behavior-driven development (or BDD) is an agile software development technique that encourages collaboration between developers, QA and non-technical or business participants in a software project.

behave uses tests written in a natural language style, backed up by Python code.

First, install *behave*._

Now make a directory called "features/". In that directory create a file called "example.feature" containing:

.. code-block:: gherkin

# -- FILE: features/example.feature
Feature: Showing off behave

  Scenario: Run a simple test
    Given we have behave installed
     When we implement 5 tests
     Then behave will test them for us!

Make a new directory called "features/steps/". In that directory create a file called "example_steps.py" containing:

.. code-block:: python

# -- FILE: features/steps/example_steps.py
from behave import given, when, then, step

@given('we have behave installed')
def step_impl(context):
    pass

@when('we implement {number:d} tests')
def step_impl(context, number):  # -- NOTE: number is converted into integer
    assert number > 1 or number == 0
    context.tests_count = number

@then('behave will test them for us!')
def step_impl(context):
    assert context.failed is False
    assert context.tests_count >= 0

Run behave:

.. code-block:: console

$ behave
Feature: Showing off behave # features/example.feature:2

  Scenario: Run a simple test          # features/example.feature:4
    Given we have behave installed     # features/steps/example_steps.py:4
    When we implement 5 tests          # features/steps/example_steps.py:8
    Then behave will test them for us! # features/steps/example_steps.py:13

1 feature passed, 0 failed, 0 skipped
1 scenario passed, 0 failed, 0 skipped
3 steps passed, 0 failed, 0 skipped, 0 undefined

Now, continue reading to learn how to get the most out of behave. To get started, we recommend the tutorial_ and then the feature testing language_ and api_ references.

.. _Install *behave*.: https://behave.readthedocs.io/en/stable/install.html .. _tutorial: https://behave.readthedocs.io/en/stable/tutorial.html#features .. _feature testing language: https://behave.readthedocs.io/en/stable/gherkin.html .. _api: https://behave.readthedocs.io/en/stable/api.html

More Information

• behave documentation: latest edition, stable edition, PDF
• behave.example_: Behave Examples and Tutorials (docs, executable examples).
• changelog_ (latest changes)

.. _behave documentation: https://behave.readthedocs.io/ .. _changelog: https://github.com/behave/behave/blob/master/CHANGES.rst .. _behave.example: https://github.com/behave/behave.example

.. _latest edition: https://behave.readthedocs.io/en/latest/ .. _stable edition: https://behave.readthedocs.io/en/stable/ .. _PDF: https://media.readthedocs.org/pdf/behave/latest/behave.pdf