Metadata-Version: 2.1
Name: semvercomp
Version: 0.1.0
Summary: Semantic Version Comparison for Python
Home-page: https://github.com/estebanborai/semvercomp
Author: Esteban Borai
Author-email: estebanborai@outlook.com
License: UNKNOWN
Description: # semvercomp
        🐍 Semantic Version Comparison for Python
        
        Implementation of a `Version` object with comparison capabilities and tag validation following [semver](https://semver.org/) conventions.
        
        ## Usage
        ### Installation
        ```bash
        pip install semvercomp
        ```
        
        ## Development
        ### Requirements
        - [pyenv](https://github.com/pyenv/pyenv)
        - [pipenv](https://pipenv.readthedocs.io/en/latest/)
        - [Visual Studio Code](https://code.visualstudio.com/) **Recommended**
        
        ### Debugging
        - Debugging tests
        Tests for this package are written with `pytest`.
        The following json, is an example of the `.vscode/settings.json`:
        ```json
        {
        	"python.pythonPath": /* Your Python Binary Address*/,
        	"python.testing.pytestArgs": [
        		"tests"
        	],
        	"python.testing.unittestEnabled": false,
        	"python.testing.nosetestsEnabled": false,
        	"python.testing.pytestEnabled": true
        }
        ```
        
        ### Testing
        - Running unit tests
        ```bash
        # from repository root directory
        pytest
        ```
        
        - Running test coverage
        ```bash
        # from repository root directory
        pytest --cov=semvercomp tests/
        
        # or with html report
        pytest --cov-report html --cov=semvercomp tests/
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
