diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 458db329..6d150a8c 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -79,7 +79,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v4 with: - python-version: "3.11" + python-version: "3.12" - name: Install linting packages run: pip install -r ./requirements/linting.txt @@ -95,7 +95,7 @@ jobs: strategy: matrix: package: ${{ fromJSON(needs.changes.outputs.packages) }} - python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"] + python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"] env: TEST_TMP: /tmp ALLURE_INDENT_OUTPUT: yep diff --git a/README.md b/README.md index 7d5cd301..47e3454a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,19 @@ # Allure Python Integrations + [![Build](https://github.com/allure-framework/allure-python/actions/workflows/build.yaml/badge.svg)](https://github.com/allure-framework/allure-python/actions/workflows/build.yaml) -The repository contains adaptors for Python-based test frameworks. -Documentation is available -[online](https://allurereport.org/docs/). +> The repository contains adapters for Python-based test frameworks. + +[Allure Report logo](https://allurereport.org "Allure Report") + +- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org) +- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report +- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community +- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates +- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community +- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action + +--- ## Pytest [![Release diff --git a/allure-behave/README.md b/allure-behave/README.md new file mode 100644 index 00000000..6a24a039 --- /dev/null +++ b/allure-behave/README.md @@ -0,0 +1,43 @@ +## Allure Behave Formatter + +[![Release Status](https://img.shields.io/pypi/v/allure-behave)](https://pypi.python.org/pypi/allure-behave) +[![Downloads](https://img.shields.io/pypi/dm/allure-behave)](https://pypi.python.org/pypi/allure-behave) + +> An Allure adapter for [Behave](https://behave.readthedocs.io/en/latest/). + +[Allure Report logo](https://allurereport.org "Allure Report") + +- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org) +- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report +- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community +- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates +- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community +- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action + +--- + +## Quick start + +```shell +$ pip install allure-behave +$ behave -f allure_behave.formatter:AllureFormatter -o %allure_result_folder% ./features +$ allure serve %allure_result_folder% +``` + +### Support behave parallel + +The current implementation of behave-parallel makes some allure features inaccessible. +In this case you need to patch your environment.py files instead of using the formatter. +If you don't use environment.py, just create a new one that calls Allure Behave like that: + +```python +from allure_behave.hooks import allure_report + +### your code + +allure_report("path/to/result/dir") +``` + +## Further readings + +Learn more from [Allure behave's official documentation](https://allurereport.org/docs/behave/). diff --git a/allure-behave/README.rst b/allure-behave/README.rst deleted file mode 100644 index ab5844bf..00000000 --- a/allure-behave/README.rst +++ /dev/null @@ -1,42 +0,0 @@ -Allure Behave Formatter -======================= -.. image:: https://img.shields.io/pypi/v/allure-behave - :alt: Release Status - :target: https://pypi.python.org/pypi/allure-behave -.. image:: https://img.shields.io/pypi/dm/allure-behave - :alt: Downloads - :target: https://pypi.python.org/pypi/allure-behave - -- `Source `_ - -- `Documentation `_ - -Installation and Usage -====================== - -.. code:: bash - - $ pip install allure-behave - $ behave -f allure_behave.formatter:AllureFormatter -o %allure_result_folder% ./features - $ allure serve %allure_result_folder% - - -Support behave parallel ------------------------ - -Current implementation of behave-parallel makes some allure features inaccessible. So in this case you need patch your -environment.py files instead using formatter. If you don't use environment.py, just crate empty one with calling allure -like in example below. - -.. code:: python - - from allure_behave.hooks import allure_report - - ### your code - - allure_report("path/to/result/dir") - -Usage examples --------------- - -See usage examples `here `_. diff --git a/allure-behave/setup.py b/allure-behave/setup.py index 78e6fbe9..7376de66 100644 --- a/allure-behave/setup.py +++ b/allure-behave/setup.py @@ -17,6 +17,7 @@ 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', 'Programming Language :: Python :: 3.11', + 'Programming Language :: Python :: 3.12', ] setup_requires = [ @@ -45,13 +46,18 @@ def main(): name=PACKAGE, use_scm_version=prepare_version, description="Allure behave integration", - url="https://github.com/allure-framework/allure-python", + url="https://allurereport.org/", + project_urls={ + "Documentation": "https://allurereport.org/docs/behave/", + "Source": "https://github.com/allure-framework/allure-python", + }, author="QAMetaSoftware, Stanislav Seliverstov", author_email="sseliverstov@qameta.io", license="Apache-2.0", classifiers=classifiers, keywords="allure reporting behave", - long_description=get_readme('README.rst'), + long_description=get_readme("README.md"), + long_description_content_type="text/markdown", packages=["allure_behave"], package_dir={"allure_behave": "src"}, setup_requires=setup_requires, diff --git a/allure-nose2/README.md b/allure-nose2/README.md new file mode 100644 index 00000000..6d142afe --- /dev/null +++ b/allure-nose2/README.md @@ -0,0 +1,17 @@ +## Allure nose2 + +[![Release Status](https://img.shields.io/pypi/v/allure-nose2)](https://pypi.python.org/pypi/allure-nose2) +[![Downloads](https://img.shields.io/pypi/dm/allure-nose2)](https://pypi.python.org/pypi/allure-nose2) + +> An Allure adapter for [nose2](https://docs.nose2.io/en/latest/). + +[Allure Report logo](https://allurereport.org "Allure Report") + +- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org) +- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report +- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community +- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates +- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community +- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action + +--- diff --git a/allure-nose2/README.rst b/allure-nose2/README.rst deleted file mode 100644 index e69de29b..00000000 diff --git a/allure-nose2/setup.py b/allure-nose2/setup.py index f0741b26..8523d912 100644 --- a/allure-nose2/setup.py +++ b/allure-nose2/setup.py @@ -16,6 +16,7 @@ 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', 'Programming Language :: Python :: 3.11', + 'Programming Language :: Python :: 3.12', ] setup_requires = [ @@ -44,13 +45,17 @@ def main(): name=PACKAGE, use_scm_version=prepare_version, description="Allure nose2 integration", - url="https://github.com/allure-framework/allure-python", + url="https://allurereport.org/", + project_urls={ + "Source": "https://github.com/allure-framework/allure-python", + }, author="QAMetaSoftware, Stanislav Seliverstov", author_email="sseliverstov@qameta.io", license="Apache-2.0", classifiers=classifiers, keywords="allure reporting nose2", - long_description=get_readme('README.rst'), + long_description=get_readme("README.md"), + long_description_content_type="text/markdown", packages=["allure_nose2"], package_dir={"allure_nose2": "src"}, setup_requires=setup_requires, diff --git a/allure-pytest-bdd/README.md b/allure-pytest-bdd/README.md new file mode 100644 index 00000000..b6edb329 --- /dev/null +++ b/allure-pytest-bdd/README.md @@ -0,0 +1,25 @@ +## Allure Pytest-BDD + +[![Release Status](https://img.shields.io/pypi/v/allure-pytest-bdd)](https://pypi.python.org/pypi/allure-pytest-bdd) +[![Downloads](https://img.shields.io/pypi/dm/allure-pytest-bdd)](https://pypi.python.org/pypi/allure-pytest-bdd) + +> An Allure adapter for [Pytest-BDD](https://pytest-bdd.readthedocs.io/en/stable/). + +[Allure Report logo](https://allurereport.org "Allure Report") + +- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org) +- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report +- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community +- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates +- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community +- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action + +--- + +## Quick start + +```shell +$ pip install allure-pytest-bdd +$ pytest --alluredir=%allure_result_folder% ./tests +$ allure serve %allure_result_folder% +``` diff --git a/allure-pytest-bdd/README.rst b/allure-pytest-bdd/README.rst deleted file mode 100644 index e69de29b..00000000 diff --git a/allure-pytest-bdd/setup.py b/allure-pytest-bdd/setup.py index bf166279..e092374b 100644 --- a/allure-pytest-bdd/setup.py +++ b/allure-pytest-bdd/setup.py @@ -17,6 +17,7 @@ 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', 'Programming Language :: Python :: 3.11', + 'Programming Language :: Python :: 3.12', ] setup_requires = [ @@ -46,13 +47,17 @@ def main(): name=PACKAGE, use_scm_version=prepare_version, description="Allure pytest-bdd integration", - url="https://github.com/allure-framework/allure-python", + url="https://allurereport.org/", + project_urls={ + "Source": "https://github.com/allure-framework/allure-python", + }, author="QAMetaSoftware, Stanislav Seliverstov", author_email="sseliverstov@qameta.io", license="Apache-2.0", classifiers=classifiers, keywords="allure reporting pytest", - long_description=get_readme('README.rst'), + long_description=get_readme("README.md"), + long_description_content_type="text/markdown", packages=["allure_pytest_bdd"], package_dir={"allure_pytest_bdd": "src"}, entry_points={"pytest11": ["allure_pytest_bdd = allure_pytest_bdd.plugin"]}, diff --git a/allure-pytest/README.md b/allure-pytest/README.md new file mode 100644 index 00000000..39abc503 --- /dev/null +++ b/allure-pytest/README.md @@ -0,0 +1,29 @@ +## Allure Pytest Plugin + +[![Release Status](https://img.shields.io/pypi/v/allure-pytest)](https://pypi.python.org/pypi/allure-pytest) +[![Downloads](https://img.shields.io/pypi/dm/allure-pytest)](https://pypi.python.org/pypi/allure-pytest) + +> An Allure adapter for [pytest](https://docs.pytest.org/en/latest/). + +[Allure Report logo](https://allurereport.org "Allure Report") + +- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org) +- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report +- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community +- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates +- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community +- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action + +--- + +## Quick start + +```shell +$ pip install allure-pytest +$ pytest --alluredir=%allure_result_folder% ./tests +$ allure serve %allure_result_folder% +``` + +## Further readings + +Learn more from [Allure pytest's official documentation](https://allurereport.org/docs/pytest/). diff --git a/allure-pytest/README.rst b/allure-pytest/README.rst deleted file mode 100644 index 4f446b0a..00000000 --- a/allure-pytest/README.rst +++ /dev/null @@ -1,28 +0,0 @@ -Allure Pytest Plugin -==================== -.. image:: https://img.shields.io/pypi/v/allure-pytest - :alt: Release Status - :target: https://pypi.python.org/pypi/allure-pytest -.. image:: https://img.shields.io/pypi/dm/allure-pytest - :alt: Downloads - :target: https://pypi.python.org/pypi/allure-pytest - -- `Source `_ - -- `Official Website `_ - -- `Documentation `_ - -Installation and Usage -====================== - -.. code:: bash - - $ pip install allure-pytest - $ py.test --alluredir=%allure_result_folder% ./tests - $ allure serve %allure_result_folder% - -Usage examples --------------- - -See usage examples `here `_. diff --git a/allure-pytest/setup.py b/allure-pytest/setup.py index 33ea2ade..1a8494c1 100644 --- a/allure-pytest/setup.py +++ b/allure-pytest/setup.py @@ -29,6 +29,7 @@ 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', 'Programming Language :: Python :: 3.11', + 'Programming Language :: Python :: 3.12', ] setup_requires = [ @@ -58,13 +59,18 @@ def main(): name=PACKAGE, use_scm_version=prepare_version, description="Allure pytest integration", - url="https://github.com/allure-framework/allure-python", + url="https://allurereport.org/", + project_urls={ + "Documentation": "https://allurereport.org/docs/pytest/", + "Source": "https://github.com/allure-framework/allure-python", + }, author="QAMetaSoftware, Stanislav Seliverstov", author_email="sseliverstov@qameta.io", license="Apache-2.0", classifiers=classifiers, keywords="allure reporting pytest", - long_description=get_readme('README.rst'), + long_description=get_readme("README.md"), + long_description_content_type="text/markdown", packages=["allure_pytest"], package_dir={"allure_pytest": "src"}, entry_points={"pytest11": ["allure_pytest = allure_pytest.plugin"]}, diff --git a/allure-python-commons/setup.py b/allure-python-commons/setup.py index cdc55421..fa9335a3 100644 --- a/allure-python-commons/setup.py +++ b/allure-python-commons/setup.py @@ -15,6 +15,7 @@ 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', 'Programming Language :: Python :: 3.11', + 'Programming Language :: Python :: 3.12', ] install_requires = [ @@ -29,7 +30,10 @@ def main(): use_scm_version={"root": "..", "relative_to": __file__}, setup_requires=['setuptools_scm'], description="Common module for integrate allure with python-based frameworks", - url="https://github.com/allure-framework/allure-python", + url="https://allurereport.org/", + project_urls={ + "Source": "https://github.com/allure-framework/allure-python", + }, author="QAMetaSoftware, Stanislav Seliverstov", author_email="sseliverstov@qameta.io", license="Apache-2.0", diff --git a/allure-robotframework/README.md b/allure-robotframework/README.md new file mode 100644 index 00000000..5c75262f --- /dev/null +++ b/allure-robotframework/README.md @@ -0,0 +1,55 @@ +## Allure Robot Framework Listener + +[![Release Status](https://img.shields.io/pypi/v/allure-robotframework)](https://pypi.python.org/pypi/allure-robotframework) +[![Downloads](https://img.shields.io/pypi/dm/allure-robotframework)](https://pypi.python.org/pypi/allure-robotframework) + +> An Allure adapter for [Robot Framework](https://robotframework.org/). + +[Allure Report logo](https://allurereport.org "Allure Report") + +- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org) +- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report +- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community +- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates +- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community +- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action + +--- + +## Installation and Usage + +```shell +$ pip install allure-robotframework +$ robot --listener allure_robotframework ./my_robot_test +``` + +The default output directory is `output/allure`. +Use the listener's argument to change it: + +```shell +$ robot --listener allure_robotframework:/set/your/path/here ./my_robot_test +``` + +The listener supports [the robotframework-pabot library](https://pypi.python.org/pypi/robotframework-pabot): + +```shell +$ pabot --listener allure_robotframework ./my_robot_test +``` + +The advanced listener settings: + + - ALLURE_MAX_STEP_MESSAGE_COUNT=5. If a robotframework step contains less + messages than has been specified by this setting, each message is shown as a substep. + This reduces the number of attachments in large projects. The default value + is zero - all messages are displayed as attachments. + +### Usage examples + +See the usage examples [here](https://github.com/allure-framework/allure-python/tree/master/allure-robotframework/examples). + +## Contributing to allure-robotframework + +This project exists thanks to all the people who contribute. Especially to +[Megafon](https://corp.megafon.com) and [@skhomuti](https://github.com/skhomuti) +who has initially started allure-robotframework and has been maintaining it +since then. diff --git a/allure-robotframework/README.rst b/allure-robotframework/README.rst deleted file mode 100644 index ee1b89e4..00000000 --- a/allure-robotframework/README.rst +++ /dev/null @@ -1,52 +0,0 @@ -Allure Robot Framework Listener -=============================== -.. image:: https://img.shields.io/pypi/v/allure-robotframework - :alt: Release Status - :target: https://pypi.python.org/pypi/allure-robotframework -.. image:: https://img.shields.io/pypi/dm/allure-robotframework - :alt: Downloads - :target: https://pypi.python.org/pypi/allure-robotframework - -- `Source `_ - -- `Official Website `_ - -- `Documentation `_ - -Installation and Usage -====================== - -.. code:: bash - - $ pip install allure-robotframework - $ robot --listener allure_robotframework ./my_robot_test - -Optional argument sets output directory. Example: - -.. code:: bash - - $ robot --listener allure_robotframework:/set/your/path/here ./my_robot_test - -Default output directory is `output/allure`. - -Listener support `robotframework-pabot library `_: - -.. code:: bash - - $ pabot --listener allure_robotframework ./my_robot_test - -Advanced listener settings: - - - ALLURE_MAX_STEP_MESSAGE_COUNT=5. If robotframework step contains less messages than specified in this setting, each message shows as substep. This reduces the number of attachments in large projects. The default value is zero - all messages are displayed as attachments. - -Usage examples --------------- - -See usage examples `here `_. - - -Contributing to allure-robotframework -===================================== - -This project exists thanks to all the people who contribute. Especially by `Megafon `_ and -`@skhomuti `_ who started and maintaining allure-robotframework. diff --git a/allure-robotframework/setup.py b/allure-robotframework/setup.py index da2519bb..f333225c 100644 --- a/allure-robotframework/setup.py +++ b/allure-robotframework/setup.py @@ -18,6 +18,7 @@ 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', 'Programming Language :: Python :: 3.11', + 'Programming Language :: Python :: 3.12', ] setup_requires = [ @@ -52,9 +53,13 @@ def get_readme(fname): packages=['allure_robotframework', 'AllureLibrary'], package_dir={"allure_robotframework": "src/listener", 'AllureLibrary': 'src/library'}, py_modules=['allure_robotframework'], - url="https://github.com/allure-framework/allure-python", + url="https://allurereport.org/", + project_urls={ + "Source": "https://github.com/allure-framework/allure-python", + }, author="Sergey Khomutinin", author_email="skhomuti@gmail.com", - long_description=get_readme('README.rst'), + long_description=get_readme("README.md"), + long_description_content_type="text/markdown", classifiers=classifiers, )