{"id":16786104,"url":"https://github.com/matheusfelipeog/vermon","last_synced_at":"2025-04-10T23:03:27.713Z","repository":{"id":43661318,"uuid":"351524034","full_name":"matheusfelipeog/vermon","owner":"matheusfelipeog","description":"Check for a newer version of your python package and notify the user about it 🔎","archived":false,"fork":false,"pushed_at":"2024-07-06T00:32:29.000Z","size":270,"stargazers_count":2,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T23:03:21.795Z","etag":null,"topics":["mit-license","notify","package-monitoring","python","python3","vermon","vermon-package","version-check","version-monitoring","version-newer"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matheusfelipeog.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-03-25T17:40:20.000Z","updated_at":"2025-03-02T12:58:33.000Z","dependencies_parsed_at":"2023-01-28T15:31:57.437Z","dependency_job_id":null,"html_url":"https://github.com/matheusfelipeog/vermon","commit_stats":{"total_commits":47,"total_committers":2,"mean_commits":23.5,"dds":0.04255319148936165,"last_synced_commit":"4fc533d05e70178652269d4aad437de6ce623092"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matheusfelipeog%2Fvermon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matheusfelipeog%2Fvermon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matheusfelipeog%2Fvermon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matheusfelipeog%2Fvermon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matheusfelipeog","download_url":"https://codeload.github.com/matheusfelipeog/vermon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248312142,"owners_count":21082638,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mit-license","notify","package-monitoring","python","python3","vermon","vermon-package","version-check","version-monitoring","version-newer"],"created_at":"2024-10-13T08:11:13.512Z","updated_at":"2025-04-10T23:03:27.690Z","avatar_url":"https://github.com/matheusfelipeog.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/matheusfelipeog/vermon/master/.github/assets/images/vermon.png\" alt=\"Logo Vermon\" width=\"450px\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://pypi.org/project/vermon/\"\u003e\n        \u003cimg alt=\"PyPI - Status\" src=\"https://img.shields.io/pypi/status/vermon\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/vermon/\"\u003e\n        \u003cimg alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/vermon\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/matheusfelipeog/vermon/releases\"\u003e\n        \u003cimg alt=\"GitHub release (latest by date)\" src=\"https://img.shields.io/github/v/release/matheusfelipeog/vermon\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/matheusfelipeog/vermon/blob/master/LICENSE\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/matheusfelipeog/vermon\" alt=\"License MIT\" /\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\n## Index\n\n- [About](#about)\n- [Install](#install)\n    - [with pipenv](#install-with-pipenv)\n    - [with pip and virtualenv](#install-with-pip-and-virtualenv)\n- [Use](#use)\n- [Contributions](#contributions)\n- [License](#license)\n\n\n## About\n\n**Vermon** monitors the version of the package specified on the [`pypi`](https://pypi.org/) platform, compares the version of the package installed in your environment with the latest published version and, if less, shows a warning with instructions for updating in the terminal.\n\n***For example:*** *suppose you created a package called `foo` and published version `1.0.0` in pypi. Some users are already using the foo package as a dependency on their projects. You found a bug and released a patch with the fix, now the latest version of `foo` is `1.0.1`. All users using version `1.0.0` (less than the last release) of the package will receive a warning on the terminal similar to this one whenever they run the project:*\n\n```bash\n\u003e python your_project.py\nYou are using an old version of the foo package (v1.0.0)\na new version has been released (v1.0.1).\nPlease run: python -m pip install foo --upgrade\n```\n\nNow users know they have a dependency that needs to be updated ;)\n\n\n## Install\n\nUse [`pipenv`](https://pipenv.pypa.io/en/latest/) to install fordev in your environment. It will create a virtual environment and separate all dependencies and subdependencies from your global environment.\n\n### Install with pipenv\n\nCreate a directory and enter it:\n\n```bash\n$ mkdir my_project \u0026\u0026 cd my_project\n```\n\nInstall with pipenv using:\n\n```bash\n$ pipenv install vermon\n```\n\nNow activate the virtual environment:\n\n```bash\n$ pipenv shell\n```\n\n### Install with pip and virtualenv\n\nAlternatively, if you don't want to use pipenv, use `pip` + `virtualenv` to do the same thing.\n\nCreate a directory and enter it:\n\n```bash\n$ mkdir my_project \u0026\u0026 cd my_project\n```\n\nCreate and activate the virtual environment:\n\n```bash\n$ virtualenv venv \u0026\u0026 source venv/Scripts/activate\n```\n\u003e Note: In linux environment, use `source venv/bin/activate` to activate the virtual environment.\n\nNow install with pip:\n\n```bash\n$ pip install vermon\n```\n\nDone, now you can start the job ;)\n\n\n## Use\n\nTo use the vermon package, call `Vermon.run` method in your package's `__init__.py` file:\n\n```python\nfrom vermon import Vermon\n\nVermon.run(\n    package='YOUR_PACKAGE',\n    current_version=your_package.__version__\n)\n```\n\nDone 🎉\n\n\n## Contributions\n\nAll contributions are welcome!\n\nFound a problem, want to give a tip? [open an issue](https://github.com/matheusfelipeog/vermon/issues)\n\nDo you have a solution to the problem? [Send me a PR](https://github.com/matheusfelipeog/vermon/pulls)\n\nDid you like this project? [Click on the star ⭐](https://github.com/matheusfelipeog/vermon/stargazers)\n\n\n## License\n\nThis project is using the MIT license, see in [MIT LICENSE](https://github.com/matheusfelipeog/vermon/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatheusfelipeog%2Fvermon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatheusfelipeog%2Fvermon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatheusfelipeog%2Fvermon/lists"}