Metadata-Version: 2.1
Name: behave-bse
Version: 1.2.7.dev5
Summary: behave is behaviour-driven development, Python style
Home-page: https://github.com/behave/behave
Author: Benno Rice, Richard Jones
Author-email: Jens Engel <jenisys@noreply.github.com>
Maintainer-email: Jens Engel <jenisys@noreply.github.com>, Peter Bittner <bittner@noreply.github.com>
License: BSD-2-Clause
Project-URL: Homepage, https://github.com/behave/behave
Project-URL: Download, https://pypi.org/project/behave/
Project-URL: Source Code, https://github.com/behave/behave
Project-URL: Issue Tracker, https://github.com/behave/behave/issues/
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 :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: Jython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Testing
Classifier: License :: OSI Approved :: BSD License
Provides: behave
Provides: setuptools_behave
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: cucumber-tag-expressions >=4.1.0
Requires-Dist: parse >=1.18.0
Requires-Dist: parse-type >=0.6.0
Requires-Dist: six >=1.15.0
Requires-Dist: colorama >=0.3.7
Requires-Dist: traceback2 ; python_version < "3.0"
Requires-Dist: toml >=0.10.2 ; python_version < "3.0"
Requires-Dist: enum34 ; python_version < "3.4"
Requires-Dist: contextlib2 ; python_version < "3.5"
Requires-Dist: win-unicode-console ; python_version <= "3.9"
Requires-Dist: tomli >=1.1.0 ; python_version >= "3.0" and python_version < "3.11"
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-cov ; extra == 'develop'
Requires-Dist: tox <4.0,>=1.8.1 ; extra == 'develop'
Requires-Dist: virtualenv <20.22.0 ; extra == 'develop'
Requires-Dist: pycmd ; extra == 'develop'
Requires-Dist: modernize >=0.5 ; extra == 'develop'
Requires-Dist: pylint ; extra == 'develop'
Requires-Dist: pytest <5.0,>=4.2 ; (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: PyHamcrest <2.0 ; (python_version < "3.0") and extra == 'develop'
Requires-Dist: path.py >=11.5.0 ; (python_version < "3.5") and extra == 'develop'
Requires-Dist: mock <4.0 ; (python_version < "3.6") and extra == 'develop'
Requires-Dist: invoke <2.0,>=1.7.0 ; (python_version < "3.6") and extra == 'develop'
Requires-Dist: pathlib ; (python_version <= "3.4") and extra == 'develop'
Requires-Dist: pytest >=5.0 ; (python_version >= "3.0") and extra == 'develop'
Requires-Dist: pytest-html >=2.0 ; (python_version >= "3.0") and extra == 'develop'
Requires-Dist: PyHamcrest >=2.0.2 ; (python_version >= "3.0") and extra == 'develop'
Requires-Dist: path >=13.1.0 ; (python_version >= "3.5") and extra == 'develop'
Requires-Dist: mock >=4.0 ; (python_version >= "3.6") and extra == 'develop'
Requires-Dist: invoke >=1.7.0 ; (python_version >= "3.6") and extra == 'develop'
Requires-Dist: ruff ; (python_version >= "3.7") and extra == 'develop'
Provides-Extra: docs
Requires-Dist: sphinx >=1.6 ; extra == 'docs'
Requires-Dist: sphinx-bootstrap-theme >=0.6 ; extra == 'docs'
Requires-Dist: Sphinx >=1.6 ; extra == 'docs'
Requires-Dist: sphinx-bootstrap-theme >=0.6.0 ; extra == 'docs'
Provides-Extra: formatters
Requires-Dist: behave-html-formatter ; 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: assertpy >=1.1 ; 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: PyHamcrest <2.0 ; (python_version < "3.0") and extra == 'testing'
Requires-Dist: path.py <13.0,>=11.5.0 ; (python_version < "3.5") and extra == 'testing'
Requires-Dist: mock <4.0 ; (python_version < "3.6") and extra == 'testing'
Requires-Dist: pathlib ; (python_version <= "3.4") and extra == 'testing'
Requires-Dist: pytest >=5.0 ; (python_version >= "3.0") and extra == 'testing'
Requires-Dist: pytest-html >=2.0 ; (python_version >= "3.0") and extra == 'testing'
Requires-Dist: PyHamcrest >=2.0.2 ; (python_version >= "3.0") and extra == 'testing'
Requires-Dist: path >=13.1.0 ; (python_version >= "3.5") and extra == 'testing'
Requires-Dist: mock >=4.0 ; (python_version >= "3.6") and extra == 'testing'
Provides-Extra: toml
Requires-Dist: toml >=0.10.2 ; (python_version < "3.0") and extra == 'toml'
Requires-Dist: tomli >=1.1.0 ; (python_version >= "3.0" and python_version < "3.11") and extra == 'toml'

======
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: http://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*.`: http://behave.readthedocs.io/en/stable/install.html
.. _`tutorial`: http://behave.readthedocs.io/en/stable/tutorial.html#features
.. _`feature testing language`: http://behave.readthedocs.io/en/stable/gherkin.html
.. _`api`: http://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: http://behave.readthedocs.io/
.. _changelog:      https://github.com/behave/behave/blob/master/CHANGES.rst
.. _behave.example: https://github.com/behave/behave.example

.. _`latest edition`: http://behave.readthedocs.io/en/latest/
.. _`stable edition`: http://behave.readthedocs.io/en/stable/
.. _PDF:              https://media.readthedocs.org/pdf/behave/latest/behave.pdf
