QA Analytics Insights
=====================
.. image:: https://img.shields.io/github/downloads/aydabd/qa-analytics-insights/total
:alt: GitHub all releases
:target: https://www.github.com/aydabd/qa-analytics-insights/releases
.. image:: https://github.com/aydabd/qa-analytics-insights/actions/workflows/ci.yml/badge.svg
:alt: GitHub Workflow Status
:target: https://www.github.com/aydabd/qa-analytics-insights/actions/workflows/ci.yml
========
Overview
========
This repository hosts the source code for the `QA Analytics Insights`_ project,
a robust command-line interface (CLI) tool designed to generate data-driven
insights from QA (Quality Assurance) test results. Test results are typically
generated in XML format by test automation frameworks such as `pytest`_ and
`unittest`_.
========
Features
========
* Analyze test results in XML format.
* Generate visualizations and metrics to better understand test performance.
* Create actionable insights to improve QA processes.
Command line tool
-----------------
The command line tool can be used to generate insights from the tests results
in xml format.
The tool can be used as follows::
$ qa-analytics-insights --help
Usage: qa-analytics-insights -f <file> [-o <output_dir>] [-vv] [-h] [-v]
The tool accepts the following arguments:
* `-f` or `--file`: Path to the file containing the tests results in xml format.
* `-o` or `--output`: Path to the directory where the insights will be generated.
* `-vv` or `--verbose`: Enable verbose mode.
* `-v` or `--version`: Show version and exit.
* `-h` or `--help`: Show help message and exit.
Library
-------
The library can be used to generate insights from the tests result in xml
format.
The library can be used as follows::
from qa_analytics_insights.result_analyzer import ResultAnalyzer
analyzer = ResultAnalyzer(
test_results_file_path='path/to/test/results/file.xml',
output_dir='path/to/output/dir',
)
============
Installation
============
To install the package from `pypi`_, run the following command::
$ pip install qa-analytics-insights
===========
Development
===========
To install the package in development mode, run the following command::
# create a virtual environment
$ virtualenv -p python3 venv
# activate the virtual environment
$ source venv/bin/activate
# Run the package in development mode
$ hatch run develop:all
For linting, run the following command::
$ hatch run linter:linter
for building the package, run the following command::
$ hatch build
for generating the documentation, run the following command::
$ hatch run docs:all
for running the tests with coverage, run the following command::
$ hatch run default:all
.. _QA Analytics Insights : https://qa-analytics-insights.readthedocs.io/en/latest/
.. _pypi: https://pypi.org/project/pip/qa-analytics-insights
.. _pytest: https://docs.pytest.org/en/latest/
.. _unittest: https://docs.python.org/3/library/unittest.html
Raw data
{
"_id": null,
"home_page": "",
"name": "qa-analytics-insights",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "analytics,assurance,black,conda,coverage,data,github,hatch,hatch-vcs,hatchling,html,insights,isort,loguru,matplotlib,mypy,nosetests,pip,pre-commit,pylint,pypi,pytest,pytest-cov,pytest-metadata,pytest-xdist,python,qa,quality,sphinx,sphinx-autodoc-typehints,sphinx-rtd-theme,testing,visualize,xml",
"author": "",
"author_email": "Aydin Abdi <ayabd18@ingka.com>",
"download_url": "https://files.pythonhosted.org/packages/23/ce/34b66586e847f213613afc3c786916b4ed5d41a60f70e76dbae48ceca66d/qa_analytics_insights-1.0.3.tar.gz",
"platform": null,
"description": "QA Analytics Insights\n=====================\n\n.. image:: https://img.shields.io/github/downloads/aydabd/qa-analytics-insights/total\n :alt: GitHub all releases\n :target: https://www.github.com/aydabd/qa-analytics-insights/releases\n\n.. image:: https://github.com/aydabd/qa-analytics-insights/actions/workflows/ci.yml/badge.svg\n :alt: GitHub Workflow Status\n :target: https://www.github.com/aydabd/qa-analytics-insights/actions/workflows/ci.yml\n\n========\nOverview\n========\n\nThis repository hosts the source code for the `QA Analytics Insights`_ project,\na robust command-line interface (CLI) tool designed to generate data-driven\ninsights from QA (Quality Assurance) test results. Test results are typically\ngenerated in XML format by test automation frameworks such as `pytest`_ and\n`unittest`_.\n\n========\nFeatures\n========\n* Analyze test results in XML format.\n* Generate visualizations and metrics to better understand test performance.\n* Create actionable insights to improve QA processes.\n\nCommand line tool\n-----------------\n\nThe command line tool can be used to generate insights from the tests results\nin xml format.\n\nThe tool can be used as follows::\n\n $ qa-analytics-insights --help\n Usage: qa-analytics-insights -f <file> [-o <output_dir>] [-vv] [-h] [-v]\n\nThe tool accepts the following arguments:\n\n * `-f` or `--file`: Path to the file containing the tests results in xml format.\n * `-o` or `--output`: Path to the directory where the insights will be generated.\n * `-vv` or `--verbose`: Enable verbose mode.\n * `-v` or `--version`: Show version and exit.\n * `-h` or `--help`: Show help message and exit.\n\n\nLibrary\n-------\n\nThe library can be used to generate insights from the tests result in xml\nformat.\n\nThe library can be used as follows::\n\n from qa_analytics_insights.result_analyzer import ResultAnalyzer\n analyzer = ResultAnalyzer(\n test_results_file_path='path/to/test/results/file.xml',\n output_dir='path/to/output/dir',\n )\n\n============\nInstallation\n============\n\nTo install the package from `pypi`_, run the following command::\n\n $ pip install qa-analytics-insights\n\n===========\nDevelopment\n===========\n\nTo install the package in development mode, run the following command::\n\n # create a virtual environment\n $ virtualenv -p python3 venv\n\n # activate the virtual environment\n $ source venv/bin/activate\n\n # Run the package in development mode\n $ hatch run develop:all\n\n\nFor linting, run the following command::\n\n $ hatch run linter:linter\n\nfor building the package, run the following command::\n\n $ hatch build\n\nfor generating the documentation, run the following command::\n\n $ hatch run docs:all\n\nfor running the tests with coverage, run the following command::\n\n $ hatch run default:all\n\n.. _QA Analytics Insights : https://qa-analytics-insights.readthedocs.io/en/latest/\n.. _pypi: https://pypi.org/project/pip/qa-analytics-insights\n.. _pytest: https://docs.pytest.org/en/latest/\n.. _unittest: https://docs.python.org/3/library/unittest.html\n",
"bugtrack_url": null,
"license": "",
"summary": "Analyze and visualize Quality Assurance data",
"version": "1.0.3",
"project_urls": {
"Documentation": "https://qa-analytics-insights.readthedocs.io/en/latest/",
"Issues": "https://github.com/aydabd/qa-analytics-insights/issues",
"Source": "https://github.com/aydabd/qa-analytics-insights"
},
"split_keywords": [
"analytics",
"assurance",
"black",
"conda",
"coverage",
"data",
"github",
"hatch",
"hatch-vcs",
"hatchling",
"html",
"insights",
"isort",
"loguru",
"matplotlib",
"mypy",
"nosetests",
"pip",
"pre-commit",
"pylint",
"pypi",
"pytest",
"pytest-cov",
"pytest-metadata",
"pytest-xdist",
"python",
"qa",
"quality",
"sphinx",
"sphinx-autodoc-typehints",
"sphinx-rtd-theme",
"testing",
"visualize",
"xml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "229bb498af468df222f20d462402c5d6dcdcbdb188e187b77ef61698d71068aa",
"md5": "07c41f9a4114388cec0cc303bd90e40e",
"sha256": "c6a5cfd2d723ec617fabe6af6beec1e05e3bf09f11364f4ccd34d174944c6f28"
},
"downloads": -1,
"filename": "qa_analytics_insights-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "07c41f9a4114388cec0cc303bd90e40e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20248,
"upload_time": "2023-09-02T22:08:49",
"upload_time_iso_8601": "2023-09-02T22:08:49.098785Z",
"url": "https://files.pythonhosted.org/packages/22/9b/b498af468df222f20d462402c5d6dcdcbdb188e187b77ef61698d71068aa/qa_analytics_insights-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "23ce34b66586e847f213613afc3c786916b4ed5d41a60f70e76dbae48ceca66d",
"md5": "eb0609984379d7f32b1c88dab6df8deb",
"sha256": "f37457628caadc29d3d6af81a5295e272bd122d46e7eed77a0548f20d9a6429e"
},
"downloads": -1,
"filename": "qa_analytics_insights-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "eb0609984379d7f32b1c88dab6df8deb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 22401,
"upload_time": "2023-09-02T22:08:50",
"upload_time_iso_8601": "2023-09-02T22:08:50.640235Z",
"url": "https://files.pythonhosted.org/packages/23/ce/34b66586e847f213613afc3c786916b4ed5d41a60f70e76dbae48ceca66d/qa_analytics_insights-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-02 22:08:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aydabd",
"github_project": "qa-analytics-insights",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qa-analytics-insights"
}
JSON
