{"id":16246999,"url":"https://github.com/magmax/python-releaseme","last_synced_at":"2026-06-11T16:31:34.096Z","repository":{"id":57460995,"uuid":"19865104","full_name":"magmax/python-releaseme","owner":"magmax","description":"Library and command line app to manage project releases or versions","archived":false,"fork":false,"pushed_at":"2018-03-05T17:35:07.000Z","size":328,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-08T11:47:18.797Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/magmax.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-16T17:35:35.000Z","updated_at":"2014-10-17T04:24:15.000Z","dependencies_parsed_at":"2022-09-17T04:30:42.585Z","dependency_job_id":null,"html_url":"https://github.com/magmax/python-releaseme","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/magmax/python-releaseme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magmax%2Fpython-releaseme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magmax%2Fpython-releaseme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magmax%2Fpython-releaseme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magmax%2Fpython-releaseme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magmax","download_url":"https://codeload.github.com/magmax/python-releaseme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magmax%2Fpython-releaseme/sbom","scorecard":{"id":611988,"data":{"date":"2025-08-11","repo":{"name":"github.com/magmax/python-releaseme","commit":"fd23ba68af71791e764a41162fb5729e379e1918"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2022-43017 / GHSA-qwmp-2cf2-g9g6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T02:52:36.419Z","repository_id":57460995,"created_at":"2025-08-21T02:52:36.419Z","updated_at":"2025-08-21T02:52:36.419Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34208762,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-10-10T14:35:24.565Z","updated_at":"2026-06-11T16:31:34.056Z","avatar_url":"https://github.com/magmax.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==============  ===============  =========  ============\nVERSION         DOWNLOADS        TESTS      COVERAGE\n==============  ===============  =========  ============\n|pip version|   |pip downloads|  |travis|   |coveralls|\n==============  ===============  =========  ============\n\nGoal and Philosophy\n===================\n\n**Releaseme** should ease the process of **versioning** a product and **increment** its version when required, despite the version is managed as a file or a repository tag.\n\n\n\nDocumentation\n=============\n\nInstallation\n------------\n\nTwo options: to install it in your system/project::\n\n    pip install releaseme\n\nAnd you can use it with::\n\n    python -m releaseme -h\n\n\nOr just `download the lastest zip`_ and use it with::\n\n   python releaseme-X.Y.Z.zip -h\n\n\nExamples and FAQ\n----------------\n\nLet's see an example. We have git project with a file in ``project/__init__.py``:\n\n.. code:: python\n\n    __version__ = '2.3.4'\n\nWe want to manage versions with **releaseme**. And just a command is required::\n\n    $ python -m releaseme.__main__ --git --file project/__init__.py\n\nWhat does this?\n~~~~~~~~~~~~~~~\n\n- Sets a git tag to 2.3.4\n- Upgrades the version in the file to '2.3.5'\n\nWhat??\n~~~~~~\n\nThis can seem a bit confusing at the beginning, but it is easy to explain: The git tag should mark the point where that version was launched, but the file should change to indicate the version we are working on.\n\nThis way, **the file will always contain the next version** to be used and the git tag, the point when it was released.\n\nCan I set an explicit version?\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYes. Just edit the file with version and put the desired one.\n\nWhat happens if there are different versions?\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe higher one will be used.\n\nWhat if I want to maintain several files?\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nNot a problem, because you can use::\n\n    $ python -m releaseme.__main__ --file project/__init__.py setup.py\n\nand it will set the same version for all of them.\n\n\nOptions\n-------\n\n**Releaseme** format is::\n\n    [-h] [-v] [--git] [--mercurial] [--file [FILE [FILE ...]]] [ACTION]\n\nWhere **Action** is any of :code:`get` or :code:`increment`. If none is provided, `increment` will be used:\n\n- `get` shows current version after processing all files.\n- `increment` will read the version and increment it in all files.\n\n:code:`--git`\n~~~~~~~~~~~~~\n\nIf you are using a Git repository, this will use git tags to get/set the version. No more arguments are required.\n\n:code:`--hg` or :code:`--mercurial`\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIf you are using a Mercurial repository, this will use mercurial tags to get/set the version. No more arguments are required.\n\n:code:`--file`\n~~~~~~~~~~~~~~\n\nAllows you to select one or several files (space separated) to manage the version.\n\nAbout the version number\n========================\n\nVersions are up to 4 numbers separated by points. In addition, it can contain a hyphon ('-') and an alphanumeric string at the end. So, valid version numbers are:\n\n- 1\n- 1.2\n- 1.2.3\n- 1.2.3.4\n- 1-foo1\n- 1.2-foo1\n- 1.2.3-foo1\n- 1.2.3.4-foo1\n\nVersion numbers that will not be managed correctly include:\n\n- 1-1\n- 1.a.1\n- 1.foo1\n\nIf more than one number is retrieved, the higher one will be used. So:\n\n- '1' vs '1.2' will use '1.2'\n- '1.2.3.4' vs '1.2' will use '1.2.3.4'\n- '1.2.1' vs '1.3.0' will use '1.3.0'\n\nFinally, only the minor number will be incremented:\n\n- '1' increments to '2'\n- '1.1' increments to '1.2'\n- '1.1-foo1' increments to '1.2-foo1'\n\nUsing it like a pro\n===================\n\nThe best way to use it is launching it just after releasing. So, the best way to do it is to add the **releaseme** call to your publishing script.\n\nWhy it doesn't support NNNN technology?\n=======================================\n\nBecause I still didn't require it. Please, feel free to add an issue and/or send a pull-request.\n\n\nLicense\n=======\n\nCopyright (c) 2014 Miguel Ángel García (`@magmax9`_).\n\nLicensed under `the MIT license`_.\n\n\n.. |travis| image:: https://travis-ci.org/magmax/python-releaseme.png\n  :target: `Travis`_\n  :alt: Travis results\n\n.. |coveralls| image:: https://coveralls.io/repos/magmax/python-releaseme/badge.png\n  :target: `Coveralls`_\n  :alt: Coveralls results_\n\n.. |pip version| image:: https://pypip.in/v/releaseme/badge.png\n    :target: https://pypi.python.org/pypi/releaseme\n    :alt: Latest PyPI version\n\n.. |pip downloads| image:: https://pypip.in/d/releaseme/badge.png\n    :target: https://pypi.python.org/pypi/releaseme\n    :alt: Number of PyPI downloads\n\n.. _Travis: https://travis-ci.org/magmax/python-releaseme\n.. _Coveralls: https://coveralls.io/r/magmax/python-releaseme\n\n.. _@magmax9: https://twitter.com/magmax9\n\n.. _the MIT license: http://opensource.org/licenses/MIT\n.. _download the lastest zip: https://pypi.python.org/pypi/releaseme\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagmax%2Fpython-releaseme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagmax%2Fpython-releaseme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagmax%2Fpython-releaseme/lists"}