resqui 0.2.0__tar.gz

resqui-0.2.0/.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+name: Deploy docs
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install docs dependencies
+        run: pip install ".[docs]"
+
+      - name: Build docs
+        run: mkdocs build
+
+      - name: Upload pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

resqui-0.2.0/.github/workflows/pypi.yml

@@ -0,0 +1,61 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          # setuptools-scm needs tags to resolve the package version.
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+
+      - name: Install build tools
+        run: python -m pip install --upgrade build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check distribution metadata
+        run: twine check dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v7
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/resqui
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v7
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.13.0

resqui-0.2.0/.github/workflows/resqui.yml

@@ -0,0 +1,17 @@
+name: Run Resqui CI
+
+on:
+  push:
+
+jobs:
+  run-resqui:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Run resqui action
+        uses: ./
+        with:
+          config: "configurations/basic.json"

resqui-0.2.0/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+name: Run tests
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install development dependencies
+        run: make install-dev
+
+      - name: Run tests with coverage
+        run: make coverage
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        if: matrix.python-version == '3.13'
+        with:
+          name: coverage-report
+          path: htmlcov/
+
+      - name: Run example
+        run: venv/bin/resqui -c configurations/basic.json -t ${{ secrets.GITHUB_TOKEN }}

resqui-0.2.0/.gitignore

@@ -0,0 +1,177 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+src/resqui/version.py
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+config.json

resqui-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: check-yaml
+        args: ["--unsafe"]
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black
+    rev: 23.12.1
+    hooks:
+    -   id: black
+-   repo: https://github.com/PyCQA/flake8
+    rev: 7.0.0
+    hooks:
+    -   id: flake8
+        args: [--ignore=E501]
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.19.1
+    hooks:
+    -   id: pyupgrade
+        args: [--py39-plus]

resqui-0.2.0/CITATION.cff

@@ -0,0 +1,28 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+type: software
+title: resqui
+authors:
+  - family-names: Gal
+    given-names: Tamas
+    orcid: https://orcid.org/0000-0001-7821-8673
+    affiliation: "Erlangen Centre for Astroparticle Physics, Friedrich-Alexander-Universität Erlangen-Nürnberg"
+  - name: "EVERSE"
+repository-code: https://github.com/EVERSE-ResearchSoftware/QualityPipelines
+url: https://github.com/EVERSE-ResearchSoftware/QualityPipelines
+abstract: A tool to check indicators related to research software quality.
+keywords:
+  - research-software
+  - software-quality
+  - quality-assessment
+  - quality-indicators
+  - continuous-integration
+  - github-action
+  - best-practices
+  - fair-principles
+  - reproducibility
+  - software-sustainability
+  - python
+license: MIT
+version: 0.1.7
+date-released: 2026-02-03

resqui-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 EVERSE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

resqui-0.2.0/Makefile

@@ -0,0 +1,45 @@
+PKGNAME=resqui
+VENV=venv
+PYTHON=$(VENV)/bin/python
+PIP=$(VENV)/bin/pip
+COVERAGE=$(VENV)/bin/coverage
+
+$(VENV)/bin/activate: pyproject.toml
+	python3 -m venv $(VENV)
+	$(PIP) install -e ".[dev,docs]"
+	touch $(VENV)/bin/activate
+
+install: $(VENV)/bin/activate
+
+install-dev: $(VENV)/bin/activate
+
+install-docs: $(VENV)/bin/activate
+
+venv: $(VENV)/bin/activate
+
+test: $(VENV)/bin/activate
+	$(COVERAGE) run -m unittest discover -s tests
+	$(COVERAGE) report -m
+
+coverage: $(VENV)/bin/activate
+	$(COVERAGE) run -m unittest discover -s tests
+	$(COVERAGE) html
+	$(COVERAGE) report -m
+
+example: $(VENV)/bin/activate
+	$(VENV)/bin/resqui -c configurations/basic.json
+
+black: $(VENV)/bin/activate
+	$(VENV)/bin/black src/$(PKGNAME)
+	$(VENV)/bin/black tests
+
+docs: $(VENV)/bin/activate
+	$(VENV)/bin/mkdocs build
+
+docs-serve: $(VENV)/bin/activate
+	$(VENV)/bin/mkdocs serve
+
+clean:
+	rm -rf venv site htmlcov .coverage
+
+.PHONY: install install-dev install-docs venv test coverage example black docs docs-serve clean

resqui-0.2.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: resqui
+Version: 0.2.0
+Summary: EVERSE Research Software Quality Indicators
+Author-email: Tamas Gal <tamas.gal@fau.de>
+Maintainer-email: Tamas Gal <tamas.gal@fau.de>
+Project-URL: Homepage, https://github.com/EVERSE-ResearchSoftware/QualityPipelines
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: setuptools_scm
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: coverage[toml]; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocstrings[python]; extra == "docs"
+Dynamic: license-file
+
+# EVERSE Software Quality Pipelines
+
+The EVERSE Software Quality Pipelines provide
+
+1) the command line tool `resqui` to check a configurable set of software quality indicators on research software via external plugins (tools); 
+2) GitHub Action to run the pipeline on a github repository.
+
+## Documentation
+
+### Quality Pipelines
+
+1) `resqui`  is installed - preferable within a Python virtual environment - as follows:
+
+```
+git clone https://github.com/EVERSE-ResearchSoftware/QualityPipelines.git
+cd QualityPipelines
+pip install .
+```
+and can be executed with these options:
+
+```
+$ resqui -h
+Usage:
+    resqui [options]
+    resqui indicators
+
+Options:
+    -u <repository_url>   URL of the repository to be analyzed.
+    -c <config_file>      Path to the configuration file.
+    -o <output_file>      Path to the output file [default: resqui_summary.json].
+    -t <github_token>     GitHub API token.
+    -d <dashverse_token>  DashVerse API token.
+    -b <branch>           The Git branch to be checked.
+    -v                    Verbose output.
+    --version             Show the version of the script.
+    --help                Show this help message.
+ ```
+The complete documentation of the quality pipelines are available at the project's [Github Pages](https://everse.software/QualityPipelines/);
+
+2) The GitHub Action to include in CI/CDs pipeline is available in [this repository](https://github.com/EVERSE-ResearchSoftware/resqui-github-action).
+
+### EVERSE Services
+
+EVERSE provides a set of services to assess and improve the quality of research software, visit the [EVERSE homepage](https://everse.software) for more information.
+
+A simplified workflow to improve the software quality is: 
+Find the practices on `RSQKit` (1), get an overview on tools and services to measure and improve the quality on the `TechRadar` (2), run an assessment on your own or your groups software via resqui (3) and display the results on `DashVERSE` (4), assess and repeat from (1).
+
+More information the services can be found at:
+
+1) Research Software Quality Kit - [RSQKit](https://everse.software/services/rsqkit/)
+2) Technology Radar - [TechRadar](https://everse.software/services/techradar/)
+3) Quality Pipelines - `resqui` which is this project
+4) Software Quality Dashboards - [DashVERSE](https://everse.software/services/dashverse/)
+

resqui-0.2.0/README.md

@@ -0,0 +1,55 @@
+# EVERSE Software Quality Pipelines
+
+The EVERSE Software Quality Pipelines provide
+
+1) the command line tool `resqui` to check a configurable set of software quality indicators on research software via external plugins (tools); 
+2) GitHub Action to run the pipeline on a github repository.
+
+## Documentation
+
+### Quality Pipelines
+
+1) `resqui`  is installed - preferable within a Python virtual environment - as follows:
+
+```
+git clone https://github.com/EVERSE-ResearchSoftware/QualityPipelines.git
+cd QualityPipelines
+pip install .
+```
+and can be executed with these options:
+
+```
+$ resqui -h
+Usage:
+    resqui [options]
+    resqui indicators
+
+Options:
+    -u <repository_url>   URL of the repository to be analyzed.
+    -c <config_file>      Path to the configuration file.
+    -o <output_file>      Path to the output file [default: resqui_summary.json].
+    -t <github_token>     GitHub API token.
+    -d <dashverse_token>  DashVerse API token.
+    -b <branch>           The Git branch to be checked.
+    -v                    Verbose output.
+    --version             Show the version of the script.
+    --help                Show this help message.
+ ```
+The complete documentation of the quality pipelines are available at the project's [Github Pages](https://everse.software/QualityPipelines/);
+
+2) The GitHub Action to include in CI/CDs pipeline is available in [this repository](https://github.com/EVERSE-ResearchSoftware/resqui-github-action).
+
+### EVERSE Services
+
+EVERSE provides a set of services to assess and improve the quality of research software, visit the [EVERSE homepage](https://everse.software) for more information.
+
+A simplified workflow to improve the software quality is: 
+Find the practices on `RSQKit` (1), get an overview on tools and services to measure and improve the quality on the `TechRadar` (2), run an assessment on your own or your groups software via resqui (3) and display the results on `DashVERSE` (4), assess and repeat from (1).
+
+More information the services can be found at:
+
+1) Research Software Quality Kit - [RSQKit](https://everse.software/services/rsqkit/)
+2) Technology Radar - [TechRadar](https://everse.software/services/techradar/)
+3) Quality Pipelines - `resqui` which is this project
+4) Software Quality Dashboards - [DashVERSE](https://everse.software/services/dashverse/)
+

resqui-0.2.0/action.yml

@@ -0,0 +1,39 @@
+name: 'Run resqui'
+description: 'Installs resqui from GitHub and runs it with an optional config file.'
+inputs:
+  config:
+    description: 'Path to the configuration file (e.g., configurations/basic.json)'
+    required: false
+  github_token:
+    description: 'GitHub token required for some indicator plugins.'
+    required: true
+  dashverse_token:
+    description: 'Dashverse token to upload the results'
+    required: false
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+
+    - name: Install resqui
+      run: |
+        python -m pip install --upgrade pip
+        pip install git+https://github.com/EVERSE-ResearchSoftware/QualityPipelines.git@main
+      shell: bash
+
+    - name: Run resqui
+      shell: bash
+      env:
+        RESQUI_GITHUB_TOKEN: ${{ inputs.github_token }}
+        RESQUI_CONFIG: ${{ inputs.config }}
+        DASHVERSE_TOKEN: ${{ inputs.dashverse_token }}
+      run: |
+        if [[ -n "$RESQUI_CONFIG" ]]; then
+          resqui -c "$RESQUI_CONFIG" -t "$RESQUI_GITHUB_TOKEN"
+        else
+          resqui -t "$RESQUI_GITHUB_TOKEN"
+        fi