Installation

Using pip (or …)

Category:Stable version Precondition:pip (or setuptools) is installed

Execute the following command to install behave with pip:

pip install behave

To update an already installed behave version, use:

pip install -U behave

Hint

See also pip related information for installing Python packages.

Using a Source Distribution

After unpacking the behave source distribution, enter the newly created directory “behave-<version>” and run:

python setup.py install

# OR:
pip install .

Using the Github Repository

Category:Bleeding edge Precondition:pip is installed

Run the following command to install the newest version from the Github repository:

pip install git+https://github.com/behave/behave

To install a tagged version from the Github repository, use:

pip install git+https://github.com/behave/behave@<tag>

where <tag> is the placeholder for an existing tag.

Optional Dependencies

If needed, additional dependencies can be installed using pip install with one of the following installation targets.

Installation Target	Description
behave[docs]	Include packages needed for building Behave’s documentation.
behave[develop]	Optional packages helpful for local development.
behave[formatters]	Install formatters from behave-contrib to extend the list of id.appendix.formatters provided by default.