Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use the standard header in all READMEs #784

Merged
merged 6 commits into from
Dec 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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"]
delatrie marked this conversation as resolved.
Show resolved Hide resolved
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
env:
TEST_TMP: /tmp
ALLURE_INDENT_OUTPUT: yep
Expand Down
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

[<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

---

## Pytest
[![Release
Expand Down
43 changes: 43 additions & 0 deletions allure-behave/README.md
Original file line number Diff line number Diff line change
@@ -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/).

[<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

---

## 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/).
42 changes: 0 additions & 42 deletions allure-behave/README.rst

This file was deleted.

10 changes: 8 additions & 2 deletions allure-behave/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down Expand Up @@ -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,
Expand Down
17 changes: 17 additions & 0 deletions allure-nose2/README.md
Original file line number Diff line number Diff line change
@@ -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/).

[<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

---
Empty file removed allure-nose2/README.rst
Empty file.
9 changes: 7 additions & 2 deletions allure-nose2/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down Expand Up @@ -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,
Expand Down
25 changes: 25 additions & 0 deletions allure-pytest-bdd/README.md
Original file line number Diff line number Diff line change
@@ -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/).

[<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

---

## Quick start

```shell
$ pip install allure-pytest-bdd
$ pytest --alluredir=%allure_result_folder% ./tests
$ allure serve %allure_result_folder%
```
Empty file removed allure-pytest-bdd/README.rst
Empty file.
9 changes: 7 additions & 2 deletions allure-pytest-bdd/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down Expand Up @@ -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"]},
Expand Down
29 changes: 29 additions & 0 deletions allure-pytest/README.md
Original file line number Diff line number Diff line change
@@ -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/).

[<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

---

## 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/).
28 changes: 0 additions & 28 deletions allure-pytest/README.rst

This file was deleted.

10 changes: 8 additions & 2 deletions allure-pytest/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down Expand Up @@ -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"]},
Expand Down
6 changes: 5 additions & 1 deletion allure-python-commons/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand All @@ -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",
Expand Down