validate-pip-version 1.0.3

CLI tool to validate the version of a local PIP package against its currently published version. Intended to be used as part of a CI build.

validate-pip-version

CLI tool to validate the version of a local PIP package against its currently published version. Intended to be used as part of a CI build.

Installation

First Install:

pip install validate-pip-version

Upgrading

pip install validate-pip-version --upgrade

GitHub Actions Example

https://github.com/werzl/validate-pip-version/blob/master/.github/workflows/CI.yml

name: CI

env:
  PACKAGE_NAME: <package_name>
  VERSION_FILE_PATH: <path_to__init__.py>

on:
  pull_request:
    branches: [master]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: "3.8"
          architecture: "x64"
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install setuptools wheel twine
      - name: Run Version Checker
        run: |
          pip install ${{ env.PACKAGE_NAME }}
          pip install validate-pip-version
          validate_pip_version check-init-file -n ${{ env.PACKAGE_NAME }} --init_file_path ${{ env.VERSION_FILE_PATH }}
      - name: Build
        run: python setup.py sdist bdist_wheel

Usage

validate_pip_version [OPTIONS] COMMAND [ARGS]

check-init-file

Retrieves the local package version from an init.py, by matching the string '__version__'.

validate_pip_version check-init-file -n <package_name> --init_file_path <path_to__init__.py>

Options

Option	Required	Description
-n, --package_name	Required	Name of the package on PyPi
--init_file_path	Required	Relative file path for the __init__.py file (uses current working dir)
--help	Optional	Show help message and exit

---

check-setup-file

Retrieves the local package version from an setup.py file, by matching the string 'version=' and stripping away spaces/newlines.

validate_pip_version check-setup-file -n <package_name> --init_file_path <path_to_setup.py>

Options

Option	Required	Description
-n, --package_name	Required	Name of the package on PyPi
--setup_file_path	Required	Relative file path for the setup.py file (uses current working dir)
--help	Optional	Show help message and exit