Welcome to semantic-version-checker documentation!¶
Check if a ‘version’ is a valid Semantic Version.
semantic_version_check python package
CLI that can be usefull for quick checks, a script or in a CI pipeline
Semantic Version format check, using Regular Expressions
Tested against multiple platforms and python versions
Here are some useful notes related to doing development on this project.
Test Suite, using pytest, located in tests dir
Parallel Execution of Unit Tests, on multiple cpu’s
Documentation Pages, hosted on readthedocs server, located in docs dir
Automation, using tox, driven by single tox.ini file
CI Pipeline, running on Github Actions, defined in .github/
Job Matrix, spanning different platform’s and python version’s
Platforms: ubuntu-latest, macos-latest
Python Interpreters: 3.6, 3.7, 3.8, 3.9, 3.10
Parallel Job execution, generated from the matrix, that runs the Test Suite
You need to have Python installed.
Using pip is the approved way for installing semantic_version_check.
python3 -m pip install semantic_version_check
Open a console and run:
check-semantic-version 1.0.0 echo $? echo "Exit code is 0 meaning operation succeeded" check-semantic-version 1.3 echo $? echo "Exit code is 1, meaning operation failed"
Free software: GNU Affero General Public License v3.0