Skip to main content

Gherkin runner compatible with Lettuce

Project description

[![Build status](]( [![Build status](]( [![Coverage](]( [![PyPI](](

A [Gherkin][gherkin] runner for Python based on [Nose][nose] and [Lettuce][lettuce].


pip install aloe

Read the [documentation][docs].


Pass the –with-gherkin argument to nosetests to run your BDD tests. You may also pass the –no-ignore-python argument to run other nose discovered tests as well.

The aloe command line tool is a wrapper for the nose runner, configured to only run Gherkin tests. As such, the invocation is the same as nose, but the following parameters are added:

  • -n N[,N…] - only run the specified scenarios (by number, 1-based) in each feature. Makes sense when only specifying one feature to run, for example

    aloe features/calculator.feature -n 1

  • –test-class - override the class used as a base for each feature.

  • –no-ignore-python - run Python tests as well as Gherkin.

Migrating from Lettuce

Aloe, started as a fork of Lettuce, tries to be compatible where it makes sense. However, there are following incompatible changes:

  • each_scenario and each_background callbacks are removed. Use each_example.
  • -s option for running particular scenarios is renamed to -n.
  • Django-related functionality, including the harvest command, is moved to a separate project, [Aloe-Django][aloe-django].
  • has no particular significance. It will be imported but only if it exists at the same directory with the other step definition files, and not above it.
  • Scenario outlines must be declared with “Scenario Outline”, and scenarios without examples must use “Scenario” - Lettuce allowed using either.
  • By default, the steps run are output as dots, corresponding to Lettuce verbosity 1. To get colored output with steps printed as they run, use -v 3.


Aloe - Cucumber runner for Python based on Lettuce and Nose

Copyright (C) <2015> Alexey Kotlyarov <>

Copyright (C) <2014-2015> Danielle Madeley <>

Copyright (C) <2010-2012> Gabriel Falcão <>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <>.

[gherkin]: [nose]: [nose-plugin-attrib]: [lettuce]: [gherkin-syntax]: [aloe-django]: [docs]:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aloe, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size aloe-0.2.0.tar.gz (97.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page