Skip to main content

pypi test coverage

pkgcheck

Dependencies

pkgcheck is developed alongside pkgcore and snakeoil. Running pkgcheck from git will often require both pkgcore and snakeoil from git as well.

For releases, see the required runtime dependencies.

There are also several optional runtime dependencies that add or extend check support in various ways if found on the host system including the following:

  • git: supports historical queries for git-based repos and commit-related checks

  • requests: supports various network-related checks

  • Gentoo-PerlMod-Version: supports Perl package version checks

  • tree-sitter-bash: used in checks that inspect the CST of ebuilds and eclasess. Must be language version >= 14.

Installing

Installing latest pypi release:

pip install pkgcheck

Installing from git:

pip install https://github.com/pkgcore/pkgcheck/archive/master.tar.gz

Installing from a tarball:

python setup.py install

Usage

Most users will use pkgcheck on the command line via pkgcheck scan to target ebuild repos. See the docs or the man page for more information on running pkgcheck.

It’s also possible to run pkgcheck natively from python. For example, to output the results for a given ebuild repo:

from pkgcheck import scan

for result in scan(['/path/to/ebuild/repo']):
    print(result)

This allows third party tools written in python to leverage pkgcheck’s scanning functionality for purposes such as CI or VCS commit support.

Tests

Normal pytest is used, just execute:

pytest

In addition, a tox config is provided so the testsuite can be run in a virtualenv setup against all supported python versions. To run tests for all environments just execute tox in the root directory of a repo or unpacked tarball. Otherwise, for a specific python version execute something similar to the following:

tox -e py313

Adding new checks

Adding a new check consists of 2 main parts: writing the logic and documentation, and adding tests for the check.

Writing the logic

  1. Select the best file for the check under src/pkgcheck/checks/.

  2. Create new classes for the results:

    • You would need to select the correct result level (style, info, warning, error) - you might want to consult QA team.

    • You would need to select the correct context: category, package, version, profile, etc.

    • Add long user friendly documentation for the result.

    • Implement the desc property which is printed to the user.

  3. Create a new class for the check:

    • Add long user friendly documentation for the result.

    • Put the source of input for the check. This is hard, so best case is to find similar check and copy the code.

    • Define the results it can return.

    • Implement the feed function.

Adding tests

  1. Select one of the repos under testdata/repos. In most cases you would want standalone.

  2. Add the ebuild/category/test case you want to catch.

  3. cd into this directory, and run pkgcheck scan --cache-dir /tmp -R JsonStream. This should yield the results you want to catch (filter out what you expect).

  4. Add the results to the test case under: testdata/data/repos/${REPO}/${CHECK CLASS}/${RESULT CLASS}/expected.json

  5. If you want to check the fix for the test case, git add the files under testdata/repos/${REPO}, modify to fix the results, and using git diff testdata/repos/${REPO} collect the diff.

  6. Copy similar patch, add the diff to the patch file, and fix file names, under: testdata/data/repos/${REPO}/${CHECK CLASS}/${RESULT CLASS}/fix.patch

Metadata

Release files for pkgcheck 0.10.49

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pkgcheck 0.10.49
File Size Uploaded Provenance Actions
pkgcheck-0.10.49.tar.gz 448.4 kB With provenance Details for pkgcheck-0.10.49.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pkgcheck 0.10.49
File Interpreter ABI Platform Actions
pkgcheck-0.10.49-py3-none-any.whl Python 3 none any Details for pkgcheck-0.10.49-py3-none-any.whl

Total release size: 660.7 kB

Release files / pkgcheck-0.10.49.tar.gz

Download URL pkgcheck-0.10.49.tar.gz
Size 448.4 kB
Tags Source
SHA-256 checksum
How to use checksums
89da686139830a0e63116a573593547596e8b0008e242fbf0110337d5a29de28
BLAKE2b-256 checksum
How to use checksums
35e9a5d9deb2ad4c35cca54890b09e1ac76cfd8f09431761f97b3b4bf4254788
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.

Transparency log

Release files / pkgcheck-0.10.49-py3-none-any.whl

Download URL pkgcheck-0.10.49-py3-none-any.whl
Size 212.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d62b79779ba5fa9a6e471ea6ffee48c1697f2f0e69d37db5c9008b366f2f5cd6
BLAKE2b-256 checksum
How to use checksums
3850b668ac35c3d7b2e9b78f433b9b58d3d11ce6910f8302b25291ee2d9044e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.

Transparency log

Security for pkgcheck 0.10.49

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for pkgcheck-0.10.49.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.10.49 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page