Metadata-Version: 2.1
Name: validate_pip_version
Version: 1.0.5
Summary: 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.
Home-page: https://github.com/werzl/validate-pip-version
Author: werzl
Author-email: werzl.mail@gmail.com
License: UNKNOWN
Description: <div align="center">
          
        # 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.
          
        [![CI](https://github.com/werzl/validate-pip-version/actions/workflows/CI.yml/badge.svg)](https://github.com/werzl/validate-pip-version/actions/workflows/CI.yml)
        [![CD](https://github.com/werzl/validate-pip-version/actions/workflows/CD.yml/badge.svg)](https://github.com/werzl/validate-pip-version/actions/workflows/CD.yml)
          
        </div>
        
        # Installation
        First Install:
          
        ```
        pip install validate-pip-version
        ```
          
        Upgrading
        ```
        pip install validate-pip-version --upgrade
        ```
          
        <br/><br/>
          
        # 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
        ```
          
        <br/>
          
        ![image](https://github.com/werzl/validate-pip-version/blob/master/github_actions_example.png?raw=true)
          
        <br/><br/>
          
        # 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
        <table>
        	<thead>
        		<tr>
        			<th>Option</th>
        			<th>Required</th>
        			<th>Description</th>
        		</tr>
        	</thead>
        	<tbody>
        		<tr>
        			<td>-n, --package_name</td>
        			<td>Required</td>
        			<td>Name of the package on PyPi</td>
        		</tr>
        		<tr>
        			<td>--init_file_path</td>
        			<td>Required</td>
        			<td>Relative file path for the __init__.py file<br/>(uses current working dir)</td>
        		</tr>
        		<tr>
        			<td>--help</td>
        			<td>Optional</td>
        			<td>Show help message and exit</td>
        		</tr>
        	</tbody>
        </table>
          
        <br/><hr/><br/>
          
        ## 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> --setup_file_path <path_to_setup.py>
        ```
          
        ### Options
        <table>
        	<thead>
        		<tr>
        			<th>Option</th>
        			<th>Required</th>
        			<th>Description</th>
        		</tr>
        	</thead>
        	<tbody>
        		<tr>
        			<td>-n, --package_name</td>
        			<td>Required</td>
        			<td>Name of the package on PyPi</td>
        		</tr>
        		<tr>
        			<td>--setup_file_path</td>
        			<td>Required</td>
        			<td>Relative file path for the setup.py file<br/>(uses current working dir)</td>
        		</tr>
        		<tr>
        			<td>--help</td>
        			<td>Optional</td>
        			<td>Show help message and exit</td>
        		</tr>
        	</tbody>
        </table>
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
