ppklib 0.1.0b1

The core functionality library for the ppk project.

ppklib - Python Package Check Library

The core functionality library behind the ppk project.

Overview

This library provides the lower-level core functionality to the primary ppk project.

As of ppk version 0.5.0, the core functionality has been moved out of ppk into this library to enable other projects to take advantage of ppk's vulnerability checking toolset.

The following vulnerability tests are available:

• MD5 checksum: The hash of the downloaded file is compared with the hash for the same file, as stored by PyPI.
• Security vulnerabilities (Snyk): The Snyk security database can be searched to determine if any vulnerabilities have been discovered and reported in the specific library.
• Security vulnerabilities (PyPA): The PyPA advisory database can be searched (via the PyPI JSON API) to determine if any vulnerabilities have been discovered and reported for a specific library.
• Security vulnerabilities (OSV): The Open Source Vulnerabilities database can be searched (via the OSV API) to determine if any vulnerabilities have been discovered and reported for a specific library.
• Code scanning: Integration coming soon, via the badsnakes project.

Getting Started

Downloading and installing

Likely, the easiest method for downloading and installing ppklib is through pip, after activating the appropriate virtual environment, as:

pip install ppklib

Note: If using the ppk project, this library must be installed into the same virtual environment which is used to run ppk.

Basic usage

Basic example usage follows. For further detail and guidance please refer to the project's documentation.

Download pandas (and dependencies) via pip:

from ppklib.pip import Download

pipdl = Download('pandas')
pipdl.get()

# Display the path to the downloaded target package.
pipdl.pkgpath

# Optional cleanup after the wheels are no longer needed.
pipdl.cleanup()

Download pandas version 2.2.3 for Windows and Python 3.13 into a specified download directory:

from ppklib.pip import Download

pipdl = Download('pandas',
                 version='2.2.3',
                 args={'platform': 'win_amd64', 'python_version': '313'},
                 tmpdir='/tmp/c0ff33')
pipdl.get()

# Display the path to the downloaded target package.
pipdl.pkgpath

# Optional cleanup after the wheels are no longer needed.
pipdl.cleanup()