Commit f914358
authored
Readme (allure-framework#64)
add readme and long description for pypi1 parent ce6186c commit f914358
7 files changed
Lines changed: 73 additions & 58 deletions
File tree
- .github
- allure-behave
- allure-pytest
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -33,9 +33,8 @@ | |||
| 33 | 33 | #### Please tell us about your environment: | |
| 34 | 34 | ||
| 35 | 35 | - Allure version: 2.1.0 | |
| 36 | - - Test framework: testng@6.8 | ||
| 37 | - - Allure adaptor: allure-testng@2.0-BETA8 | ||
| 38 | - - Generate report using: allure-maven@2.18 | ||
| 36 | + - Test framework: pytest@3.0 | ||
| 37 | + - Allure adaptor: allure-pytest@2.0.0b1 | ||
| 39 | 38 | ||
| 40 | 39 | #### Other information | |
| 41 | 40 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,23 @@ | |||
| 1 | + # Allure Python Integrations | ||
| 2 | + | ||
| 3 | + The repository contains adaptors for python-based test frameworks. | ||
| 4 | + Documentation is available [online](https://docs.qameta.io/allure/2.0/), also you can get help at | ||
| 5 | + [gitter chanel](https://gitter.im/allure-framework/allure-core) | ||
| 6 | + | ||
| 7 | + | ||
| 8 | + ## Pytest | ||
| 9 | + Allure [pytest](http://pytest.org) integration. It's developed as pytest plugin and distributed via | ||
| 10 | + [pypi](https://pypi.python.org/pypi/allure-pytest) | ||
| 11 | + | ||
| 12 | + | ||
| 13 | + ## Behave | ||
| 14 | + Allure [behave](http://pythonhosted.org/behave/) integration. Just external formatter that produce test results in | ||
| 15 | + allure2 format. This package is available on [pypi](https://pypi.python.org/pypi/allure-behave) | ||
| 16 | + | ||
| 17 | + | ||
| 18 | + ## Allure python commons | ||
| 19 | + Common engine for all modules. It is useful for make integration with your homemade frameworks. | ||
| 20 | + | ||
| 21 | + | ||
| 22 | + ## Allure python testing | ||
| 23 | + Just pack of hamcrest matchers for validation result in allure2 json format. | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,18 @@ | |||
| 1 | + Allure Behave Formatter | ||
| 2 | + ======================= | ||
| 3 | + | ||
| 4 | + - `Source <https://github.com/allure-framework/allure-python>`_ | ||
| 5 | + | ||
| 6 | + - `Documentation <https://docs.qameta.io/allure/2.0/>`_ | ||
| 7 | + | ||
| 8 | + - `Gitter <https://gitter.im/allure-framework/allure-core>`_ | ||
| 9 | + | ||
| 10 | + | ||
| 11 | + Installation and Usage | ||
| 12 | + ====================== | ||
| 13 | + | ||
| 14 | + .. code:: bash | ||
| 15 | + | ||
| 16 | + $ pip install allure-behave | ||
| 17 | + $ behave -f allure_behave.formatter:AllureFormatter -o %allure_result_folder% ./features | ||
| 18 | + $ allure serve %allure_result_folder% | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,3 +1,4 @@ | |||
| 1 | + import os | ||
| 1 | 2 | from setuptools import setup | |
| 2 | 3 | ||
| 3 | 4 | PACKAGE = "allure-behave" | |
@@ -17,6 +18,10 @@ | |||
| 17 | 18 | ] | |
| 18 | 19 | ||
| 19 | 20 | ||
| 21 | + def read(fname): | ||
| 22 | + return open(os.path.join(os.path.dirname(__file__), fname)).read() | ||
| 23 | + | ||
| 24 | + | ||
| 20 | 25 | def main(): | |
| 21 | 26 | setup( | |
| 22 | 27 | name=PACKAGE, | |
@@ -28,6 +33,7 @@ def main(): | |||
| 28 | 33 | license="Apache-2.0", | |
| 29 | 34 | classifiers=classifiers, | |
| 30 | 35 | keywords="allure reporting behave", | |
| 36 | + long_description=read('README.rst'), | ||
| 31 | 37 | packages=["allure_behave"], | |
| 32 | 38 | package_dir={"allure_behave": "src"}, | |
| 33 | 39 | install_requires=install_requires | |
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,18 @@ | |||
| 1 | + Allure Pytest Plugin | ||
| 2 | + ==================== | ||
| 3 | + | ||
| 4 | + - `Source <https://github.com/allure-framework/allure-python>`_ | ||
| 5 | + | ||
| 6 | + - `Documentation <https://docs.qameta.io/allure/2.0/>`_ | ||
| 7 | + | ||
| 8 | + - `Gitter <https://gitter.im/allure-framework/allure-core>`_ | ||
| 9 | + | ||
| 10 | + | ||
| 11 | + Installation and Usage | ||
| 12 | + ====================== | ||
| 13 | + | ||
| 14 | + .. code:: bash | ||
| 15 | + | ||
| 16 | + $ pip install allure-pytest | ||
| 17 | + $ py.test --alluredir=%allure_result_folder% ./tests | ||
| 18 | + $ allure serve %allure_result_folder% | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,3 +1,4 @@ | |||
| 1 | + import os | ||
| 1 | 2 | from setuptools import setup | |
| 2 | 3 | ||
| 3 | 4 | PACKAGE = "allure-pytest" | |
@@ -18,6 +19,10 @@ | |||
| 18 | 19 | ] | |
| 19 | 20 | ||
| 20 | 21 | ||
| 22 | + def read(fname): | ||
| 23 | + return open(os.path.join(os.path.dirname(__file__), fname)).read() | ||
| 24 | + | ||
| 25 | + | ||
| 21 | 26 | def main(): | |
| 22 | 27 | setup( | |
| 23 | 28 | name=PACKAGE, | |
@@ -29,6 +34,7 @@ def main(): | |||
| 29 | 34 | license="Apache-2.0", | |
| 30 | 35 | classifiers=classifiers, | |
| 31 | 36 | keywords="allure reporting pytest", | |
| 37 | + long_description=read('README.rst'), | ||
| 32 | 38 | packages=["allure_pytest"], | |
| 33 | 39 | package_dir={"allure_pytest": "src"}, | |
| 34 | 40 | entry_points={"pytest11": ["allure_pytest = allure_pytest.plugin"]}, | |
0 commit comments