Software development process data gathering
===========================================
[](https://pypi.python.org/pypi/gros-gatherer)
[](https://github.com/grip-on-software/data-gathering/actions/workflows/gatherer-tests.yml)
[](https://coveralls.io/github/grip-on-software/data-gathering?branch=master)
[](https://sonarcloud.io/project/overview?id=grip-on-software_data-gathering)
[](https://doi.org/10.5281/zenodo.10911862)
The Python modules in this repository gather data from different sources that
are used by software development teams and projects, as well as control
a distributed setup of data gathering. The data gathering modules are part of
Grip on Software, a research project involving a larger pipeline where the
gathered data is made available for analysis purposes through a MonetDB
database setup.
The following systems from software development processes are able to be
interacted with using the GROS gatherer modules, focusing on data acquisition:
- Jira
- Git, including additional repository data from GitHub and GitLab
- Azure DevOps/VSTS/TFS, including Git-based data
- Subversion
- Jenkins
- Quality-time
- SonarQube
- BigBoat
There are many ways to use the GROS gatherer, such as manual script usage,
Docker images, Jenkins jobs, agent-based Docker compose network isolation,
central controller instances and usage in other applications. However, this
README.md document focuses on the module installation and development. More
thorough documentation on compatibility with versions of data sources,
configuration, script overviews and agent-controller APIs is found in the
[online data-gathering documentation](https://gros.liacs.nl/data-gathering/).
## Installation
The data gathering modules require Python version 3.8 and higher.
To obtain the latest release version of the module and its dependencies from
PyPI, use the following command:
```
pip install gros-gatherer
```
We recommend creating a virtual environment to manage your dependencies. Make
sure that `python` runs the Python version in the virtual environment.
Otherwise, the dependencies are installed to the system libraries path or the
user's Python libraries path if you do not have access to the system libraries.
## Configuration
Some modules require the existence of settings and credentials files in the
directory from which the script importing the module is run. This path is
adjustable with environment variables. For details on configuration, view the
[documentation](https://gros.liacs.nl/data-gathering/configuration.html).
## Development and testing
Most of the modules come with unit tests, while also depending on the
correctness of dependencies to provide accurate data from sources (i.e. our
unit tests often use mocks in place of the dependencies) and testing the actual
system in non-production settings. To run unit tests in this repository, first
install the test dependencies with `make setup_test` which also installs all
dependencies for the modules. Then `coverage run tests.py` provides test
results in the output, with XML versions compatible with, e.g., JUnit and
SonarQube available in the `test-reports/` directory. Detailed information on
test coverage is also obtainable after a test run in various report formats,
for example:
- `coverage report -m` for a report on (counts of) statements and branches that
were hit and missed in the modules in the output.
- `coverage html` for a HTML report in the `htmlcov/` directory.
- `coverage xml -i` for an XML output suitable for, e.g., SonarQube.
To perform all the steps except the HTML report, run `make coverage`. If you do
not need XML outputs (each test class writes an XML file by default), then run
`make test` to just report on test successes and failures or `make cover` to
also have the terminal report on statement/branch hits/misses.
[GitHub Actions](https://github.com/grip-on-software/data-gathering/actions) is
used to run the unit tests and report on coverage on commits and pull requests.
This includes quality gate scans tracked by
[SonarCloud](https://sonarcloud.io/project/overview?id=grip-on-software_data-gathering)
and [Coveralls](https://coveralls.io/github/grip-on-software/data-gathering)
for coverage history.
The Python scripts and modules conform to code style and typing standards which
may be checked using Pylint with `make pylint` and mypy with `make mypy`,
respectively, after running `make setup_analysis` to install static code
analysis tools. The command for mypy provides potential errors in the output
and typing coverage reports in several formats, including XML (compatible with
JUnit and SonarQube) in the `mypy-report/` directory. To also receive the HTML
report, use `make mypy_html` instead.
Finally, the schemas in the `schema/` directory allow validation of certain
configuration files as well as all the exported artifacts against the schema.
For example, the Jira and Azure DevOps field mapping specifications are able to
be checked; see the [issue
trackers](https://gros.liacs.nl/data-gathering/configuration.html#issue-trackers-jira-and-azure-devops)
documentation section for an example.
We publish releases to [PyPI](https://pypi.org/project/gros-gatherer/) using
`make setup_release` to install dependencies from `requirements-release.txt`
and `make release` which performs multiple checks: unit tests, typing, lint and
version number consistency. The release files are also published on
[GitHub](https://github.com/grip-on-software/data-gathering/releases) and from
there are archived on [Zenodo](https://zenodo.org/doi/10.5281/zenodo.10911861).
Noteworthy changes to the modules are added to the
[changelog](https://gros.liacs.nl/data-gathering/changelog.html).
## License
Data gathering scripts and modules are licensed under the Apache 2.0 License.
Raw data
{
"_id": null,
"home_page": null,
"name": "gros-gatherer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "software development process, data gathering",
"author": null,
"author_email": "Leon Helwerda <l.s.helwerda@liacs.leidenuniv.nl>",
"download_url": "https://files.pythonhosted.org/packages/fd/81/6ea64382994c5c9f21ecb538411bd4e146fa19838e60aa2ab52664d11d52/gros_gatherer-1.0.0.tar.gz",
"platform": null,
"description": "Software development process data gathering\n===========================================\n\n[](https://pypi.python.org/pypi/gros-gatherer)\n[](https://github.com/grip-on-software/data-gathering/actions/workflows/gatherer-tests.yml)\n[](https://coveralls.io/github/grip-on-software/data-gathering?branch=master)\n[](https://sonarcloud.io/project/overview?id=grip-on-software_data-gathering)\n[](https://doi.org/10.5281/zenodo.10911862)\n\nThe Python modules in this repository gather data from different sources that \nare used by software development teams and projects, as well as control \na distributed setup of data gathering. The data gathering modules are part of \nGrip on Software, a research project involving a larger pipeline where the \ngathered data is made available for analysis purposes through a MonetDB \ndatabase setup.\n\nThe following systems from software development processes are able to be \ninteracted with using the GROS gatherer modules, focusing on data acquisition:\n\n- Jira\n- Git, including additional repository data from GitHub and GitLab\n- Azure DevOps/VSTS/TFS, including Git-based data\n- Subversion\n- Jenkins\n- Quality-time\n- SonarQube\n- BigBoat\n\nThere are many ways to use the GROS gatherer, such as manual script usage, \nDocker images, Jenkins jobs, agent-based Docker compose network isolation, \ncentral controller instances and usage in other applications. However, this \nREADME.md document focuses on the module installation and development. More \nthorough documentation on compatibility with versions of data sources, \nconfiguration, script overviews and agent-controller APIs is found in the \n[online data-gathering documentation](https://gros.liacs.nl/data-gathering/).\n\n## Installation\n\nThe data gathering modules require Python version 3.8 and higher.\n\nTo obtain the latest release version of the module and its dependencies from \nPyPI, use the following command:\n\n```\npip install gros-gatherer\n```\n\nWe recommend creating a virtual environment to manage your dependencies. Make \nsure that `python` runs the Python version in the virtual environment. \nOtherwise, the dependencies are installed to the system libraries path or the \nuser's Python libraries path if you do not have access to the system libraries. \n\n## Configuration\n\nSome modules require the existence of settings and credentials files in the \ndirectory from which the script importing the module is run. This path is \nadjustable with environment variables. For details on configuration, view the \n[documentation](https://gros.liacs.nl/data-gathering/configuration.html).\n\n## Development and testing\n\nMost of the modules come with unit tests, while also depending on the \ncorrectness of dependencies to provide accurate data from sources (i.e. our \nunit tests often use mocks in place of the dependencies) and testing the actual \nsystem in non-production settings. To run unit tests in this repository, first \ninstall the test dependencies with `make setup_test` which also installs all \ndependencies for the modules. Then `coverage run tests.py` provides test \nresults in the output, with XML versions compatible with, e.g., JUnit and \nSonarQube available in the `test-reports/` directory. Detailed information on \ntest coverage is also obtainable after a test run in various report formats, \nfor example:\n\n- `coverage report -m` for a report on (counts of) statements and branches that \n were hit and missed in the modules in the output.\n- `coverage html` for a HTML report in the `htmlcov/` directory.\n- `coverage xml -i` for an XML output suitable for, e.g., SonarQube.\n\nTo perform all the steps except the HTML report, run `make coverage`. If you do \nnot need XML outputs (each test class writes an XML file by default), then run \n`make test` to just report on test successes and failures or `make cover` to \nalso have the terminal report on statement/branch hits/misses.\n\n[GitHub Actions](https://github.com/grip-on-software/data-gathering/actions) is \nused to run the unit tests and report on coverage on commits and pull requests. \nThis includes quality gate scans tracked by \n[SonarCloud](https://sonarcloud.io/project/overview?id=grip-on-software_data-gathering) \nand [Coveralls](https://coveralls.io/github/grip-on-software/data-gathering) \nfor coverage history.\n\nThe Python scripts and modules conform to code style and typing standards which \nmay be checked using Pylint with `make pylint` and mypy with `make mypy`, \nrespectively, after running `make setup_analysis` to install static code \nanalysis tools. The command for mypy provides potential errors in the output \nand typing coverage reports in several formats, including XML (compatible with \nJUnit and SonarQube) in the `mypy-report/` directory. To also receive the HTML \nreport, use `make mypy_html` instead.\n\nFinally, the schemas in the `schema/` directory allow validation of certain \nconfiguration files as well as all the exported artifacts against the schema. \nFor example, the Jira and Azure DevOps field mapping specifications are able to \nbe checked; see the [issue \ntrackers](https://gros.liacs.nl/data-gathering/configuration.html#issue-trackers-jira-and-azure-devops) \ndocumentation section for an example.\n\nWe publish releases to [PyPI](https://pypi.org/project/gros-gatherer/) using \n`make setup_release` to install dependencies from `requirements-release.txt` \nand `make release` which performs multiple checks: unit tests, typing, lint and \nversion number consistency. The release files are also published on \n[GitHub](https://github.com/grip-on-software/data-gathering/releases) and from \nthere are archived on [Zenodo](https://zenodo.org/doi/10.5281/zenodo.10911861). \nNoteworthy changes to the modules are added to the \n[changelog](https://gros.liacs.nl/data-gathering/changelog.html).\n\n## License\n\nData gathering scripts and modules are licensed under the Apache 2.0 License.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Software development process data gathering",
"version": "1.0.0",
"project_urls": {
"CI: Coveralls": "https://coveralls.io/github/grip-on-software/data-gathering?branch=master",
"CI: GitHub Actions": "https://github.com/grip-on-software/data-gathering/actions",
"CI: SonarCloud": "https://sonarcloud.io/project/overview?id=grip-on-software_data-gathering",
"Documentation": "https://gros.liacs.nl/data-gathering/",
"Homepage": "https://gros.liacs.nl",
"Issues": "https://github.com/grip-on-software/data-gathering/issues",
"Pull Requests": "https://github.com/grip-on-software/data-gathering/pulls",
"PyPI": "https://pypi.python.org/pypi/gros-gatherer",
"Source Code": "https://github.com/grip-on-software/data-gathering"
},
"split_keywords": [
"software development process",
" data gathering"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "000add6e2608a53b8e32fda977775ff7135025249334dc22840499d02fdb3706",
"md5": "c0216b7f51256a13986e7c89ffab2490",
"sha256": "443fae5de74ca06a25eab4bcc90faae0a1568bb83a7d0c313205b6b96653a256"
},
"downloads": -1,
"filename": "gros_gatherer-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c0216b7f51256a13986e7c89ffab2490",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 176448,
"upload_time": "2024-07-13T15:05:26",
"upload_time_iso_8601": "2024-07-13T15:05:26.723611Z",
"url": "https://files.pythonhosted.org/packages/00/0a/dd6e2608a53b8e32fda977775ff7135025249334dc22840499d02fdb3706/gros_gatherer-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fd816ea64382994c5c9f21ecb538411bd4e146fa19838e60aa2ab52664d11d52",
"md5": "d2f9d2e643449290a45eedeed83c10fe",
"sha256": "a10431f6fd05aaced0843152384d8435a66877b7df6ad1ec9371b139d87c923e"
},
"downloads": -1,
"filename": "gros_gatherer-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d2f9d2e643449290a45eedeed83c10fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 126126,
"upload_time": "2024-07-13T15:05:28",
"upload_time_iso_8601": "2024-07-13T15:05:28.576040Z",
"url": "https://files.pythonhosted.org/packages/fd/81/6ea64382994c5c9f21ecb538411bd4e146fa19838e60aa2ab52664d11d52/gros_gatherer-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-13 15:05:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "grip-on-software",
"github_project": "data-gathering",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "gros-gatherer"
}
JSON
