-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improve documentation for Qase TestOps Python reporters
- Added clear section headers for better readability - Expanded descriptions for each project, including use cases and recommendations - Marked deprecated projects explicitly and provided migration guidance - Refined language for consistency and clarity
- Loading branch information
Showing
1 changed file
with
28 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,31 @@ | ||
# [Qase TestOps](https://qase.io) reporters for Python | ||
# [Qase TestOps](https://qase.io) Reporters for Python | ||
|
||
Monorepo with [Qase TestOps](https://qase.io) reporters for Python testing frameworks. | ||
Monorepo containing [Qase TestOps](https://qase.io) integration tools for Python testing frameworks. This repository includes reporters and API clients designed to streamline the process of reporting test results to Qase TestOps. | ||
|
||
## Projects | ||
## Projects Overview | ||
|
||
- [qase-pytest](/qase-pytest) - Pytest reporter for Qase Report and Qase TestOps | ||
- [qase-robotframework](/qase-robotframework) - Robot Framework reporter | ||
- [qase-python-commons](/qase-python-commons/) - Library with common components shared across reporters | ||
- [qase-api-client](/qase-api-client) - Qase TestOps API client (v1) | ||
- [qase-api-v2-client](/qase-api-v2-client) - Qase TestOps API client (v2) | ||
- [qaseio](/qaseio) - Qase TestOps API client (v1). Deprecated, use qase-api-client instead | ||
### Reporters | ||
|
||
- **[qase-pytest](/qase-pytest)** | ||
Reporter for Pytest, including built-in support for Playwright-based tests. | ||
|
||
- **[qase-robotframework](/qase-robotframework)** | ||
Reporter for Robot Framework, enabling seamless integration with Qase TestOps. | ||
|
||
### Libraries | ||
|
||
- **[qase-python-commons](/qase-python-commons/)** | ||
Shared library containing common components and utilities used by Qase reporters. | ||
|
||
### API Clients | ||
|
||
- **[qase-api-client](/qase-api-client)** | ||
Official client for interacting with the Qase TestOps API (v1). Recommended for most use cases. | ||
|
||
- **[qase-api-v2-client](/qase-api-v2-client)** | ||
API client supporting the new Qase TestOps API (v2). Use this client for projects leveraging the latest API features. | ||
|
||
### Deprecated | ||
|
||
- **[qaseio](/qaseio)** | ||
Legacy client for the Qase TestOps API (v1). Deprecated in favor of `qase-api-client` and should not be used in new projects. |