Metadata-Version: 2.4
Name: behave
Version: 1.3.1
Summary: behave is behaviour-driven development, Python style
Author: Benno Rice, Richard Jones
Author-email: Jens Engel <jenisys@noreply.github.com>
Maintainer: Jens Engel, Peter Bittner
Maintainer-email: Jens Engel <jenisys@noreply.github.com>, Peter Bittner <bittner@noreply.github.com>
License-Expression: BSD-2-Clause
Project-URL: Homepage, https://github.com/behave/behave
Project-URL: Documentation, https://behave.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/behave/behave
Project-URL: Issues, https://github.com/behave/behave/issues/
Project-URL: Changelog, https://github.com/behave/behave/blob/main/CHANGES.rst
Keywords: BDD,behavior-driven-development,bdd-framework,behave,gherkin,cucumber-like
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: Jython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Testing
Provides: behave
Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,>=2.7
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: cucumber-tag-expressions>=4.1.0
Requires-Dist: cucumber-expressions>=17.1.0; python_version >= "3.8"
Requires-Dist: enum34; python_version < "3.4"
Requires-Dist: parse>=1.18.0
Requires-Dist: parse-type>=0.6.0
Requires-Dist: six>=1.15.0
Requires-Dist: traceback2; python_version < "3.0"
Requires-Dist: win_unicode_console; python_version <= "3.9"
Requires-Dist: contextlib2; python_version < "3.5"
Requires-Dist: colorama>=0.3.7
Requires-Dist: tomli>=1.1.0; python_version >= "3.0" and python_version < "3.11"
Requires-Dist: toml>=0.10.2; python_version < "3.0"
Provides-Extra: develop
Requires-Dist: build>=0.5.1; extra == "develop"
Requires-Dist: twine>=1.13.0; extra == "develop"
Requires-Dist: coverage>=5.0; extra == "develop"
Requires-Dist: pytest<5.0,>=4.2; python_version < "3.0" and extra == "develop"
Requires-Dist: pytest>=5.0; python_version >= "3.0" and extra == "develop"
Requires-Dist: pytest-html<2.0,>=1.19.0; python_version < "3.0" and extra == "develop"
Requires-Dist: pytest-html>=2.0; python_version >= "3.0" and extra == "develop"
Requires-Dist: mock<4.0; python_version < "3.6" and extra == "develop"
Requires-Dist: mock>=4.0; python_version >= "3.6" and extra == "develop"
Requires-Dist: PyHamcrest>=2.0.2; python_version >= "3.0" and extra == "develop"
Requires-Dist: PyHamcrest<2.0; python_version < "3.0" and extra == "develop"
Requires-Dist: pytest-cov; extra == "develop"
Requires-Dist: tox<4.0,>=3.28.0; extra == "develop"
Requires-Dist: virtualenv>=20.26.6; python_version >= "3.7" and extra == "develop"
Requires-Dist: virtualenv<20.22.0; python_version < "3.7" and extra == "develop"
Requires-Dist: invoke<2.0,>=1.7.0; python_version < "3.6" and extra == "develop"
Requires-Dist: invoke>=1.7.0; python_version >= "3.6" and extra == "develop"
Requires-Dist: path>=13.1.0; python_version >= "3.5" and extra == "develop"
Requires-Dist: path.py>=11.5.0; python_version < "3.5" and extra == "develop"
Requires-Dist: pycmd; extra == "develop"
Requires-Dist: pathlib; python_version <= "3.4" and extra == "develop"
Requires-Dist: modernize>=0.5; extra == "develop"
Requires-Dist: pylint; extra == "develop"
Requires-Dist: ruff; python_version >= "3.7" and extra == "develop"
Provides-Extra: docs
Requires-Dist: sphinx>=7.3.7; python_version >= "3.7" and extra == "docs"
Requires-Dist: sphinx<4.4,>=1.6; python_version < "3.7" and extra == "docs"
Requires-Dist: furo>=2024.04.27; python_version >= "3.8" and extra == "docs"
Requires-Dist: sphinxcontrib-applehelp>=1.0.8; python_version >= "3.7" and extra == "docs"
Requires-Dist: sphinxcontrib-htmlhelp>=2.0.5; python_version >= "3.7" and extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5.2; python_version >= "3.7" and extra == "docs"
Provides-Extra: formatters
Requires-Dist: behave-html-formatter>=0.9.10; python_version >= "3.6" and extra == "formatters"
Requires-Dist: behave-html-pretty-formatter>=1.9.1; python_version >= "3.6" and extra == "formatters"
Provides-Extra: testing
Requires-Dist: pytest<5.0; python_version < "3.0" and extra == "testing"
Requires-Dist: pytest>=5.0; python_version >= "3.0" and extra == "testing"
Requires-Dist: pytest-html<2.0,>=1.19.0; python_version < "3.0" and extra == "testing"
Requires-Dist: pytest-html>=2.0; python_version >= "3.0" and extra == "testing"
Requires-Dist: mock<4.0; python_version < "3.6" and extra == "testing"
Requires-Dist: mock>=4.0; python_version >= "3.6" and extra == "testing"
Requires-Dist: PyHamcrest>=2.0.2; python_version >= "3.0" and extra == "testing"
Requires-Dist: PyHamcrest<2.0; python_version < "3.0" and extra == "testing"
Requires-Dist: assertpy>=1.1; extra == "testing"
Requires-Dist: chardet; extra == "testing"
Requires-Dist: path>=13.1.0; python_version >= "3.5" and extra == "testing"
Requires-Dist: path.py<13.0,>=11.5.0; python_version < "3.5" and extra == "testing"
Requires-Dist: pathlib; python_version <= "3.4" and extra == "testing"
Requires-Dist: freezegun>=1.5.1; python_version > "3.7" and extra == "testing"
Dynamic: license-file
Dynamic: provides

======
behave
======

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

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

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

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

.. |badge.discussions| image:: https://img.shields.io/badge/chat-github_discussions-darkgreen
   :target: https://github.com/behave/behave/discussions
   :alt: Discussions at https://github.com/behave/behave/discussions

.. |badge.gitter| image:: https://badges.gitter.im/join_chat.svg
   :target: https://app.gitter.im/#/room/#behave_behave:gitter.im
   :alt: Chat at https://gitter.im/behave/behave

.. |badge.gurubase| image:: https://img.shields.io/badge/Gurubase-Ask%20behave%20Guru-006BFF
   :target: https://gurubase.io/g/behave
   :alt: Ask behave Guru at https://gurubase.io/g/behave


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

|badge.latest_version| |badge.license| |badge.CI_status| |badge.docs_status| |badge.discussions| |badge.gitter| |badge.gurubase|

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/main/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://behave.readthedocs.io/_/downloads/en/stable/pdf/
