Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muhammad-fiaz/checkversions
CheckVersions is a powerful and intuitive version comparison tool designed to simplify the process of discerning the latest and older versions in software development.
https://github.com/muhammad-fiaz/checkversions
check check-version check-versions checkversion checkversions compare-version compare-versions major minor patch pip python python-package python3 version version-check version-checker version-compare version-control version-number
Last synced: 7 days ago
JSON representation
CheckVersions is a powerful and intuitive version comparison tool designed to simplify the process of discerning the latest and older versions in software development.
- Host: GitHub
- URL: https://github.com/muhammad-fiaz/checkversions
- Owner: muhammad-fiaz
- License: mit
- Created: 2023-12-06T13:30:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-29T11:39:28.000Z (8 months ago)
- Last Synced: 2024-05-02T05:18:28.352Z (8 months ago)
- Topics: check, check-version, check-versions, checkversion, checkversions, compare-version, compare-versions, major, minor, patch, pip, python, python-package, python3, version, version-check, version-checker, version-compare, version-control, version-number
- Language: Python
- Homepage: https://pypi.org/project/checkversions/
- Size: 70.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# CheckVersions
[](https://github.com/muhammad-fiaz/checkversions/actions/workflows/python-package.yml)
[](https://pypi.org/project/checkversions/)
[](https://pypi.org/project/checkversions/)
[](https://opensource.org/licenses/MIT)
[](https://pypi.org/project/checkversions/)
[](https://github.com/muhammad-fiaz/checkversions)
[](https://github.com/muhammad-fiaz/checkversions/issues)
[](https://github.com/muhammad-fiaz/checkversions/stargazers)
[](https://github.com/muhammad-fiaz/checkversions/network)
[](https://github.com/muhammad-fiaz)
[](https://github.com/sponsors/muhammad-fiaz)
[](https://opensource.org/licenses/MIT)
[](https://github.com/muhammad-fiaz/checkversions)
CheckVersions is a powerful and intuitive version comparison tool designed to simplify the process of discerning the latest and older versions in software development.
## Features
- **Semantic Version Analysis:** 🧐 Leverage our sophisticated semantic versioning analysis engine to compare versions like "0.0.0-beta" effortlessly.
- **Automated Version Ranking:** 🚀 CheckVersions automatically ranks versions based on their priority, allowing you to quickly identify the latest version.
- **Efficient Version Delta Assessment:** 📊 CheckVersions provides a simple and efficient way to assess the difference between two versions.
- **User-Friendly Interface:** 🎨 Our intuitive user interface ensures that developers can effortlessly compare versions.
- **Secure Version Analysis:** 🔒 Security is paramount. CheckVersions ensures version comparison is performed securely, protecting your intellectual property and facilitating risk-free decision-making in your development process.
- **Custom Hierarchy** 📝 Customize the hierarchy of version words to suit your needs. For instance, you can assign a higher priority to "beta" than "alpha" if you wish.
- **Older Version Retrieval:** ⏳ Optionally retrieve the older version when comparing two versions by setting the `older_version` parameter to `True`.
## Getting Started
## Installation
```bash
pip install checkversions
```
## Usage
```python3
from checkversions import *
# Example 1: Basic Version Comparison
current_version = "v1.0.0"
latest_version = "v1.0.0-beta"
result = compare_versions(current_version, latest_version)
print(result)
# Output: v1.0.0
```
In this example, we demonstrate a basic version comparison. The compare_versions function is used to compare the current_version (v1.0.0) with the latest_version (v1.0.0-beta). The result is printed, and it shows that the latest version is v1.0.0.
```python3
from checkversions import *
# Example 2: Comparing Versions with Hyphens and Words
version1 = "2.0.0-beta"
version2 = "2.0.1-alpha"
result = compare_versions(version1, version2)
print(result)
# Output: 2.0.1-alpha
```
In this example, we showcase version comparison with hyphens and additional words. The compare_versions function compares version1 (2.0.0-beta) with version2 (2.0.1-alpha). The result is printed, indicating that the latest version is 2.0.1-alpha.
## Default Hierarchy
```json
{
"beta": 0,
"prerelease": 1,
"alpha": 2,
"unstable": 3,
"stable": 4,
"release": 5
}
```
The default hierarchy is a JSON representation that assigns priority values to version words. For instance, "beta" has a priority of 0, "prerelease" has a priority of 1, and so on.
## Custom Hierarchy
```python3
from checkversions import *
# Example 3: Custom Hierarchy
# Define a custom hierarchy
custom_hierarchy = {"beta": 0, "alpha": 1, "rc": 2, "gamma": 3, "stable": 4}
version1 = "v1.0.0-beta"
version2 = "v1.0.1-alpha"
result = compare_versions(version1, version2, custom_hierarchy)
print(result)
# Output: v1.0.1-alpha
```
In this example, we introduce a custom hierarchy for version comparison. The custom_hierarchy dictionary is defined with version words and their corresponding priority. The compare_versions function uses this custom hierarchy to compare version1 (v1.0.0-beta) with version2 (v1.0.1-alpha). The result is printed, indicating that the latest version is v1.0.1-alpha.
## Older Version
```python3
from checkversions import *
current_version = "v1.0.0"
latest_version = "v1.0.0-beta"
# Example with older_version=True
result_older = compare_versions(current_version, latest_version, older_version=True)
print(f"Older version: {result_older}")
# Output: Older version: v1.0.0-beta
```
In this example, by setting older_version=True, the function returns and prints the older version (v1.0.0-beta) based on the provided versions (v1.0.0 and v1.0.0-beta). If older_version is omitted or set to False, it would return and print the latest version.
## Contributing
Contributions are welcome! Before contributing, please read our [Contributing Guidelines](CONTRIBUTING.md) to ensure a smooth and collaborative development process.
## Code of Conduct
Please review our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the standards of behavior we expect from contributors and users of this project.
## License
This project is licensed under the [MIT License](). See [LICENSE](LICENSE) for more details.
## Support the Project
💰 You can help me improve more by offering a little support on any platform❤️
[](https://buymeacoffee.com/muhammadfiaz) [](https://patreon.com/muhammadfiaz) [](https://ko-fi.com/muhammadfiaz)
[](https://github.com/sponsors/muhammad-fiaz)
[](https://opencollective.com/muhammadfiaz)
## Happy Coding ❤️