allure-python-commons


Nameallure-python-commons JSON
Version 2.13.5 PyPI version JSON
download
home_pagehttps://allurereport.org/
Summary('Contains the API for end users as well as helper functions and classes to build Allure adapters for Python test frameworks',)
upload_time2024-04-01 16:51:03
maintainerNone
docs_urlNone
authorQameta Software Inc., Stanislav Seliverstov
requires_python>=3.6
licenseApache-2.0
keywords allure reporting report-engine
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            ## Allure Common API

[![Release Status](https://img.shields.io/pypi/v/allure-python-commons)](https://pypi.python.org/pypi/allure-python-commons)
[![Downloads](https://img.shields.io/pypi/dm/allure-python-commons)](https://pypi.python.org/pypi/allure-python-commons)

> The package contains classes and functions for users of Allure Report. It can
> be used to enhance reports using an existing Allure adapter or to create new
> adapters.

[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](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

---

## User's API

Install an adapter that suits your test framework. You can then add more
information to the report by using functions from the `allure` module.

### Decorators API

Use these functions as decorators of your own functions, e.g.:

```python
import allure

@allure.title("My test")
def test_fn():
    pass
```

The full list of decorators:

  - `allure.title`
  - `allure.description`
  - `allure.description_html`
  - `allure.label`
  - `allure.severity`
  - `allure.epic`
  - `allure.feature`
  - `allure.story`
  - `allure.suite`
  - `allure.parent_suite`
  - `allure.sub_suite`
  - `allure.tag`
  - `allure.id`
  - `allure.manual`
  - `allure.link`
  - `allure.issue`
  - `allure.testcase`
  - `allure.step`

Refer to the adapter's documentation for the information about what decorators
are supported and what functions they can be applied to.

### Runtime API

Most of the functions of Runtime API can be accessed via `allure.dynamic.*`.
Call them at runtime from your code.

The full list includes:

  - `allure.dynamic.title`
  - `allure.dynamic.description`
  - `allure.dynamic.description_html`
  - `allure.dynamic.label`
  - `allure.dynamic.severity`
  - `allure.dynamic.epic`
  - `allure.dynamic.feature`
  - `allure.dynamic.story`
  - `allure.dynamic.suite`
  - `allure.dynamic.parent_suite`
  - `allure.dynamic.sub_suite`
  - `allure.dynamic.tag`
  - `allure.dynamic.id`
  - `allure.dynamic.manual`
  - `allure.dynamic.link`
  - `allure.dynamic.issue`
  - `allure.dynamic.testcase`
  - `allure.dynamic.parameter`
  - `allure.attach`
  - `allure.attach.file`
  - `allure.step`

Refer to the adapter's documentation for the information about what functions
are supported and where you can use them.

## Adapter API

You may use `allure-pytest-commons` to build your own Allure adapter. The key
elements of the corresponding API are:

  - `allure_python_commons.model2`: the object model of Allure Report.
  - `allure_python_commons.logger`: classes that are used to emit Allure Report objects (tests, containers, attachments):
      - `AllureFileLogger`: emits to the file system.
      - `AllureMemoryLogger`: collects the objects in memory. Useful for
        testing.
  - `allure_python_commons.lifecycle.AllureLifecycle`: an implementation of
    Allure lifecycle that doesn't isolate the state between threads.
  - `allure_python_commons.reporter.AllureReporter`: an implementation of
    Allure lifecycle that supports some multithreaded scenarios.

A new version of the API is likely to be released in the future as we need
a decent support for multithreaded and async-based concurrency (see
[here](https://github.com/allure-framework/allure-python/issues/697) and
[here](https://github.com/allure-framework/allure-python/issues/720)).

Raw data

            {
    "_id": null,
    "home_page": "https://allurereport.org/",
    "name": "allure-python-commons",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "allure reporting report-engine",
    "author": "Qameta Software Inc., Stanislav Seliverstov",
    "author_email": "sseliverstov@qameta.io",
    "download_url": "https://files.pythonhosted.org/packages/2d/96/9991a10dcd25b98c8c3e4c7916780f33f13a55a0efbe8c7ea96505271d91/allure-python-commons-2.13.5.tar.gz",
    "platform": null,
    "description": "## Allure Common API\n\n[![Release Status](https://img.shields.io/pypi/v/allure-python-commons)](https://pypi.python.org/pypi/allure-python-commons)\n[![Downloads](https://img.shields.io/pypi/dm/allure-python-commons)](https://pypi.python.org/pypi/allure-python-commons)\n\n> The package contains classes and functions for users of Allure Report. It can\n> be used to enhance reports using an existing Allure adapter or to create new\n> adapters.\n\n[<img src=\"https://allurereport.org/public/img/allure-report.svg\" height=\"85px\" alt=\"Allure Report logo\" align=\"right\" />](https://allurereport.org \"Allure Report\")\n\n- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org)\n- \ud83d\udcda [Documentation](https://allurereport.org/docs/) \u2013 discover official documentation for Allure Report\n- \u2753 [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) \u2013 get help from the team and community\n- \ud83d\udce2 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) \u2013  stay updated with our latest news and updates\n- \ud83d\udcac [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) \u2013 engage in casual conversations, share insights and ideas with the community\n- \ud83d\udda5\ufe0f [Live Demo](https://demo.allurereport.org/) \u2014 explore a live example of Allure Report in action\n\n---\n\n## User's API\n\nInstall an adapter that suits your test framework. You can then add more\ninformation to the report by using functions from the `allure` module.\n\n### Decorators API\n\nUse these functions as decorators of your own functions, e.g.:\n\n```python\nimport allure\n\n@allure.title(\"My test\")\ndef test_fn():\n    pass\n```\n\nThe full list of decorators:\n\n  - `allure.title`\n  - `allure.description`\n  - `allure.description_html`\n  - `allure.label`\n  - `allure.severity`\n  - `allure.epic`\n  - `allure.feature`\n  - `allure.story`\n  - `allure.suite`\n  - `allure.parent_suite`\n  - `allure.sub_suite`\n  - `allure.tag`\n  - `allure.id`\n  - `allure.manual`\n  - `allure.link`\n  - `allure.issue`\n  - `allure.testcase`\n  - `allure.step`\n\nRefer to the adapter's documentation for the information about what decorators\nare supported and what functions they can be applied to.\n\n### Runtime API\n\nMost of the functions of Runtime API can be accessed via `allure.dynamic.*`.\nCall them at runtime from your code.\n\nThe full list includes:\n\n  - `allure.dynamic.title`\n  - `allure.dynamic.description`\n  - `allure.dynamic.description_html`\n  - `allure.dynamic.label`\n  - `allure.dynamic.severity`\n  - `allure.dynamic.epic`\n  - `allure.dynamic.feature`\n  - `allure.dynamic.story`\n  - `allure.dynamic.suite`\n  - `allure.dynamic.parent_suite`\n  - `allure.dynamic.sub_suite`\n  - `allure.dynamic.tag`\n  - `allure.dynamic.id`\n  - `allure.dynamic.manual`\n  - `allure.dynamic.link`\n  - `allure.dynamic.issue`\n  - `allure.dynamic.testcase`\n  - `allure.dynamic.parameter`\n  - `allure.attach`\n  - `allure.attach.file`\n  - `allure.step`\n\nRefer to the adapter's documentation for the information about what functions\nare supported and where you can use them.\n\n## Adapter API\n\nYou may use `allure-pytest-commons` to build your own Allure adapter. The key\nelements of the corresponding API are:\n\n  - `allure_python_commons.model2`: the object model of Allure Report.\n  - `allure_python_commons.logger`: classes that are used to emit Allure Report objects (tests, containers, attachments):\n      - `AllureFileLogger`: emits to the file system.\n      - `AllureMemoryLogger`: collects the objects in memory. Useful for\n        testing.\n  - `allure_python_commons.lifecycle.AllureLifecycle`: an implementation of\n    Allure lifecycle that doesn't isolate the state between threads.\n  - `allure_python_commons.reporter.AllureReporter`: an implementation of\n    Allure lifecycle that supports some multithreaded scenarios.\n\nA new version of the API is likely to be released in the future as we need\na decent support for multithreaded and async-based concurrency (see\n[here](https://github.com/allure-framework/allure-python/issues/697) and\n[here](https://github.com/allure-framework/allure-python/issues/720)).\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "('Contains the API for end users as well as helper functions and classes to build Allure adapters for Python test frameworks',)",
    "version": "2.13.5",
    "project_urls": {
        "Homepage": "https://allurereport.org/",
        "Source": "https://github.com/allure-framework/allure-python"
    },
    "split_keywords": [
        "allure",
        "reporting",
        "report-engine"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d01879a66d6adc301281803398f7288583dff8d1d3f2672c07ffab03ee12c7cd",
                "md5": "e3bb0910b69114f49093966cbd82b942",
                "sha256": "8b0e837b6e32d810adec563f49e1d04127a5b6770e0232065b7cb09b9953980d"
            },
            "downloads": -1,
            "filename": "allure_python_commons-2.13.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e3bb0910b69114f49093966cbd82b942",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 15715,
            "upload_time": "2024-04-01T16:51:02",
            "upload_time_iso_8601": "2024-04-01T16:51:02.336763Z",
            "url": "https://files.pythonhosted.org/packages/d0/18/79a66d6adc301281803398f7288583dff8d1d3f2672c07ffab03ee12c7cd/allure_python_commons-2.13.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2d969991a10dcd25b98c8c3e4c7916780f33f13a55a0efbe8c7ea96505271d91",
                "md5": "019f753d486faf366ef540ec490b16f0",
                "sha256": "a232e7955811f988e49a4c1dd6c16cce7e9b81d0ea0422b1e5654d3254e2caf3"
            },
            "downloads": -1,
            "filename": "allure-python-commons-2.13.5.tar.gz",
            "has_sig": false,
            "md5_digest": "019f753d486faf366ef540ec490b16f0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 12934,
            "upload_time": "2024-04-01T16:51:03",
            "upload_time_iso_8601": "2024-04-01T16:51:03.711875Z",
            "url": "https://files.pythonhosted.org/packages/2d/96/9991a10dcd25b98c8c3e4c7916780f33f13a55a0efbe8c7ea96505271d91/allure-python-commons-2.13.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-01 16:51:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "allure-framework",
    "github_project": "allure-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "allure-python-commons"
}
Qameta Software Inc., Stanislav Seliverstov
Elapsed time: 0.23602s