Installing

Install locally

  1. Prerequisites

  • Install bubblewrap (sandboxing tool)

  • Install strace (file access tracking)

  • activated Python virtual environment such as miniconda or virtualenv, Python Version 3.10 or higher.

  1. Install PipCanary

pip install pipcanary

  1. Test installation

pipcanary --help

Install in Container

  1. Prerequisites

  • Docker from your Linux distribution or Docker Desktop.

see: https://github.com/sebastian-kuebeck/pipcanary/tree/main/examples/ci-cd/

  1. Build container

docker build -t pipcanary-cicd .

Test installation

  1. Create shared directory and sample requirements file

mkdir -p shared

cat << END > shared/requirements.txt
 Werkzeug<=3.1.7
 click<=8.3.1
 flask
 pip==26.1
END

  1. Run container

docker run --privileged -v "$(PWD)/shared:/var/shared" pipcanary-cicd

From Source

  1. Prerequisites

  • Docker from your Linux distribution or Docker Desktop.

  • git distributed version control system

  • Python Version >= 3.10

  • activated Python virtual environment such as miniconda or virtualenv

  1. Download

git clone https://github.com/sebastian-kuebeck/pipcanary
cd pipcanary
pip install -r requirements-dev-locked.txt

  1. Test (optional)

Run unit tests:

make test

  1. Build wheel

make dist

If all goes well, the pipcanary wheel file will be in the dist directory.

It’s named dist/pipcanary-<version>-py3-none-any.whl

  1. Install wheel

pip install dist/pipcanary-<version>-py3-none-any.whl