Aloe
====
[](https://travis-ci.org/aloetesting/aloe)
[](https://ci.appveyor.com/project/aloetesting/aloe)
[](https://coveralls.io/github/aloetesting/aloe)
[](https://pypi.python.org/pypi/aloe)
A [Gherkin][gherkin] runner for Python based on [Nose][nose] and
[Lettuce][lettuce].
Install:
pip install aloe
Read the [documentation][docs].
Invocation
----------
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].
* `terrain.py` 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`.
License
-------
Aloe - Cucumber runner for Python based on Lettuce and Nose
Copyright (C) <2015> Alexey Kotlyarov <a@koterpillar.com>
Copyright (C) <2014-2015> Danielle Madeley <danielle@madeley.id.au>
Copyright (C) <2010-2012> Gabriel Falcão <gabriel@nacaolivre.org>
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 <http://www.gnu.org/licenses/>.
[gherkin]: https://cucumber.io/
[nose]: https://nose.readthedocs.io/
[nose-plugin-attrib]: https://nose.readthedocs.io/en/latest/plugins/attrib.html
[lettuce]: http://lettuce.it/
[gherkin-syntax]: https://cucumber.io/docs/reference
[aloe-django]: https://github.com/aloetesting/aloe_django
[docs]: http://aloe.readthedocs.io/
Raw data
{
"_id": null,
"home_page": "https://github.com/aloetesting/aloe",
"name": "aloe",
"maintainer": "",
"docs_url": "https://pythonhosted.org/aloe/",
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Alexey Kotlyarov",
"author_email": "a@koterpillar.com",
"download_url": "https://files.pythonhosted.org/packages/d6/43/f64222832386b8dc31078086aa157ba67581275630974a204f3df52da56e/aloe-0.2.0.tar.gz",
"platform": "",
"description": "Aloe\n====\n\n[](https://travis-ci.org/aloetesting/aloe)\n[](https://ci.appveyor.com/project/aloetesting/aloe)\n[](https://coveralls.io/github/aloetesting/aloe)\n[](https://pypi.python.org/pypi/aloe)\n\nA [Gherkin][gherkin] runner for Python based on [Nose][nose] and\n[Lettuce][lettuce].\n\nInstall:\n\n pip install aloe\n\nRead the [documentation][docs].\n\nInvocation\n----------\n\nPass the `--with-gherkin` argument to `nosetests` to run your BDD tests. You\nmay also pass the `--no-ignore-python` argument to run other nose discovered\ntests as well.\n\nThe `aloe` command line tool is a wrapper for the `nose` runner, configured to\nonly run Gherkin tests. As such, the invocation is the same as `nose`, but the\nfollowing parameters are added:\n\n* `-n N[,N...]` - only run the specified scenarios (by number, 1-based) in each\n feature. Makes sense when only specifying one feature to run, for example\n\n `aloe features/calculator.feature -n 1`\n\n* `--test-class` - override the class used as a base for each feature.\n\n* `--no-ignore-python` - run Python tests as well as Gherkin.\n\nMigrating from Lettuce\n----------------------\n\nAloe, started as a fork of Lettuce, tries to be compatible where it makes\nsense. However, there are following incompatible changes:\n\n* `each_scenario` and `each_background` callbacks are removed. Use\n `each_example`.\n* `-s` option for running particular scenarios is renamed to `-n`.\n* Django-related functionality, including the `harvest` command, is moved to a\n separate project, [Aloe-Django][aloe-django].\n* `terrain.py` has no particular significance. It will be imported but only if\n it exists at the same directory with the other step definition files, and not\n above it.\n* Scenario outlines must be declared with \"Scenario Outline\", and scenarios\n without examples must use \"Scenario\" - Lettuce allowed using either.\n* By default, the steps run are output as dots, corresponding to Lettuce\n verbosity 1. To get colored output with steps printed as they run, use `-v 3`.\n\nLicense\n-------\n\nAloe - Cucumber runner for Python based on Lettuce and Nose\n\nCopyright (C) <2015> Alexey Kotlyarov <a@koterpillar.com>\n\nCopyright (C) <2014-2015> Danielle Madeley <danielle@madeley.id.au>\n\nCopyright (C) <2010-2012> Gabriel Falc\u00e3o <gabriel@nacaolivre.org>\n\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see <http://www.gnu.org/licenses/>.\n\n[gherkin]: https://cucumber.io/\n[nose]: https://nose.readthedocs.io/\n[nose-plugin-attrib]: https://nose.readthedocs.io/en/latest/plugins/attrib.html\n[lettuce]: http://lettuce.it/\n[gherkin-syntax]: https://cucumber.io/docs/reference\n[aloe-django]: https://github.com/aloetesting/aloe_django\n[docs]: http://aloe.readthedocs.io/",
"bugtrack_url": null,
"license": "",
"summary": "Gherkin runner compatible with Lettuce",
"version": "0.2.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "39da771cbb9581933de571bc94fbf854",
"sha256": "d73f69d933600f3ba20c6773df485cc42b5b2e8c274fa3f6798750aedbaf5aa2"
},
"downloads": -1,
"filename": "aloe-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "39da771cbb9581933de571bc94fbf854",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 97193,
"upload_time": "2020-01-12T04:58:52",
"upload_time_iso_8601": "2020-01-12T04:58:52.558259Z",
"url": "https://files.pythonhosted.org/packages/d6/43/f64222832386b8dc31078086aa157ba67581275630974a204f3df52da56e/aloe-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-01-12 04:58:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "aloetesting",
"github_project": "aloe",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"appveyor": true,
"requirements": [
{
"name": "ansicolors",
"specs": [
[
">=",
"1.1.8"
]
]
},
{
"name": "colorama",
"specs": [
[
">=",
"0.3.9"
]
]
},
{
"name": "gherkin-official",
"specs": [
[
">=",
"4.1.3"
],
[
"<",
"5"
]
]
},
{
"name": "nose",
"specs": []
}
],
"test_requirements": [
{
"name": "coverage",
"specs": []
},
{
"name": "factory_boy",
"specs": []
},
{
"name": "mock",
"specs": []
},
{
"name": "pycodestyle",
"specs": []
},
{
"name": "pylint",
"specs": [
[
">=",
"2.4.3"
]
]
},
{
"name": "setuptools_scm",
"specs": []
},
{
"name": "Sphinx",
"specs": []
}
],
"lcname": "aloe"
}
JSON
