Skip to content

Commit f5db4f4

Browse files
delatriedelatrie
authored
Use the standard header in all READMEs (#784)
1 parent 078370e commit f5db4f4

File tree

18 files changed

+226
-138
lines changed

18 files changed

+226
-138
lines changed

‎.github/workflows/build.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ jobs:
7979
- name: Set up Python
8080
uses: actions/setup-python@v4
8181
with:
82-
python-version: "3.11"
82+
python-version: "3.12"
8383

8484
- name: Install linting packages
8585
run: pip install -r ./requirements/linting.txt
@@ -95,7 +95,7 @@ jobs:
9595
strategy:
9696
matrix:
9797
package: ${{ fromJSON(needs.changes.outputs.packages) }}
98-
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
98+
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
9999
env:
100100
TEST_TMP: /tmp
101101
ALLURE_INDENT_OUTPUT: yep

‎README.md‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
# Allure Python Integrations
2+
23
[![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)
34

4-
The repository contains adaptors for Python-based test frameworks.
5-
Documentation is available
6-
[online](https://allurereport.org/docs/).
5+
> The repository contains adapters for Python-based test frameworks.
6+
7+
[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")
8+
9+
- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org)
10+
- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
11+
- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
12+
- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates
13+
- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
14+
- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action
15+
16+
---
717

818
## Pytest
919
[![Release

‎allure-behave/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Allure Behave Formatter
2+
3+
[![Release Status](https://img.shields.io/pypi/v/allure-behave)](https://pypi.python.org/pypi/allure-behave)
4+
[![Downloads](https://img.shields.io/pypi/dm/allure-behave)](https://pypi.python.org/pypi/allure-behave)
5+
6+
> An Allure adapter for [Behave](https://behave.readthedocs.io/en/latest/).
7+
8+
[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")
9+
10+
- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org)
11+
- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
12+
- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
13+
- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates
14+
- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
15+
- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action
16+
17+
---
18+
19+
## Quick start
20+
21+
```shell
22+
$ pip install allure-behave
23+
$ behave -f allure_behave.formatter:AllureFormatter -o %allure_result_folder% ./features
24+
$ allure serve %allure_result_folder%
25+
```
26+
27+
### Support behave parallel
28+
29+
The current implementation of behave-parallel makes some allure features inaccessible.
30+
In this case you need to patch your environment.py files instead of using the formatter.
31+
If you don't use environment.py, just create a new one that calls Allure Behave like that:
32+
33+
```python
34+
from allure_behave.hooks import allure_report
35+
36+
### your code
37+
38+
allure_report("path/to/result/dir")
39+
```
40+
41+
## Further readings
42+
43+
Learn more from [Allure behave's official documentation](https://allurereport.org/docs/behave/).

‎allure-behave/README.rst‎

Lines changed: 0 additions & 42 deletions
This file was deleted.

‎allure-behave/setup.py‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
'Programming Language :: Python :: 3.9',
1818
'Programming Language :: Python :: 3.10',
1919
'Programming Language :: Python :: 3.11',
20+
'Programming Language :: Python :: 3.12',
2021
]
2122

2223
setup_requires = [
@@ -45,13 +46,18 @@ def main():
4546
name=PACKAGE,
4647
use_scm_version=prepare_version,
4748
description="Allure behave integration",
48-
url="https://github.com/allure-framework/allure-python",
49+
url="https://allurereport.org/",
50+
project_urls={
51+
"Documentation": "https://allurereport.org/docs/behave/",
52+
"Source": "https://github.com/allure-framework/allure-python",
53+
},
4954
author="QAMetaSoftware, Stanislav Seliverstov",
5055
author_email="sseliverstov@qameta.io",
5156
license="Apache-2.0",
5257
classifiers=classifiers,
5358
keywords="allure reporting behave",
54-
long_description=get_readme('README.rst'),
59+
long_description=get_readme("README.md"),
60+
long_description_content_type="text/markdown",
5561
packages=["allure_behave"],
5662
package_dir={"allure_behave": "src"},
5763
setup_requires=setup_requires,

‎allure-nose2/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Allure nose2
2+
3+
[![Release Status](https://img.shields.io/pypi/v/allure-nose2)](https://pypi.python.org/pypi/allure-nose2)
4+
[![Downloads](https://img.shields.io/pypi/dm/allure-nose2)](https://pypi.python.org/pypi/allure-nose2)
5+
6+
> An Allure adapter for [nose2](https://docs.nose2.io/en/latest/).
7+
8+
[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")
9+
10+
- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org)
11+
- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
12+
- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
13+
- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates
14+
- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
15+
- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action
16+
17+
---

‎allure-nose2/README.rst‎

Whitespace-only changes.

‎allure-nose2/setup.py‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
'Programming Language :: Python :: 3.9',
1717
'Programming Language :: Python :: 3.10',
1818
'Programming Language :: Python :: 3.11',
19+
'Programming Language :: Python :: 3.12',
1920
]
2021

2122
setup_requires = [
@@ -44,13 +45,17 @@ def main():
4445
name=PACKAGE,
4546
use_scm_version=prepare_version,
4647
description="Allure nose2 integration",
47-
url="https://github.com/allure-framework/allure-python",
48+
url="https://allurereport.org/",
49+
project_urls={
50+
"Source": "https://github.com/allure-framework/allure-python",
51+
},
4852
author="QAMetaSoftware, Stanislav Seliverstov",
4953
author_email="sseliverstov@qameta.io",
5054
license="Apache-2.0",
5155
classifiers=classifiers,
5256
keywords="allure reporting nose2",
53-
long_description=get_readme('README.rst'),
57+
long_description=get_readme("README.md"),
58+
long_description_content_type="text/markdown",
5459
packages=["allure_nose2"],
5560
package_dir={"allure_nose2": "src"},
5661
setup_requires=setup_requires,

‎allure-pytest-bdd/README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Allure Pytest-BDD
2+
3+
[![Release Status](https://img.shields.io/pypi/v/allure-pytest-bdd)](https://pypi.python.org/pypi/allure-pytest-bdd)
4+
[![Downloads](https://img.shields.io/pypi/dm/allure-pytest-bdd)](https://pypi.python.org/pypi/allure-pytest-bdd)
5+
6+
> An Allure adapter for [Pytest-BDD](https://pytest-bdd.readthedocs.io/en/stable/).
7+
8+
[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")
9+
10+
- Learn more about Allure Report at [https://allurereport.org](https://allurereport.org)
11+
- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
12+
- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
13+
- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – stay updated with our latest news and updates
14+
- 💬 [General Discussion](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
15+
- 🖥️ [Live Demo](https://demo.allurereport.org/) — explore a live example of Allure Report in action
16+
17+
---
18+
19+
## Quick start
20+
21+
```shell
22+
$ pip install allure-pytest-bdd
23+
$ pytest --alluredir=%allure_result_folder% ./tests
24+
$ allure serve %allure_result_folder%
25+
```

‎allure-pytest-bdd/README.rst‎

Whitespace-only changes.

0 commit comments

Comments
 (0)