Introduction
============
Find newer versions of your installed Python packages, or newer versions of
packages in a buildout file.
This package provides a console script named ``checkversions``.
.. image:: https://github.com/zopefoundation/z3c.checkversions/actions/workflows/tests.yml/badge.svg
:target: https://github.com/zopefoundation/z3c.checkversions/actions/workflows/tests.yml
.. contents::
Install
=======
you can install this package either in a virtualenv::
$ virtualenv sandbox
$ sandbox/bin/pip install z3c.checkversions
$ sandbox/bin/checkversions --help
or in your system::
$ sudo pip install z3c.checkversions
$ checkversions --help
or in a buildout::
[buildout]
parts = checkversions
[checkversions]
recipe=zc.recipe.egg
eggs=z3c.checkversions [buildout]
Note that buildout support is optional and must be enabled with [buildout] so
that zc.buildout is installed as well.
If you need buildout support while installing this package via pip
you have to install it like this:
pip install z3c.checkversions[buildout]
Usage
=====
::
$ checkversions -h
Usage: checkversions [-v] [-1] [-l LEVEL] [-i INDEX] [-b BLACKLIST] [buildout_file]
This script will check new package versions of either your current installed
distributions or a buildout file if provided. It can detect major or minor
versions availability: level 0 gets the highest version (X.y.z), level 1 gets
the highest intermediate version (x.Y.z), level 2 gets the highest minor
version (x.y.Z). Using level 2, you can automatically retrieve all bugfix
versions of a buildout. If you provide a blacklist file with bad versions,
these versions won't be suggested.
Options:
-h, --help show this help message and exit
-l LEVEL, --level=LEVEL
Version level to check
-i INDEX, --index=INDEX
Provide and alternative package index URL
-b BLACKLIST, --blacklist=BLACKLIST
Provide a blacklist file with bad versions
-1, --incremental Suggest only one upgrade. Skip others.
-v, --verbose Verbose mode (prints old versions too)
Examples
========
For installed packages
----------------------
Example with a virtualenv::
$ virtualenv --no-site-packages sandbox
$ sandbox/bin/pip install z3c.checkversions
$ sandbox/bin/checkversions -v -l 1
# Checking your installed distributions
pip=0.7.1 # was: 0.6.3
For a buildout
--------------
It can work either with a full buildout.cfg or with a simple versions.cfg file.
Here is a sample `versions.cfg` file::
[versions]
somepackage=0.5.3
otherpackage=0.1.1
You can generate a new versions.cfg ::
$ checkversions -v -l 1 versions.cfg
# Checking buildout file versions.cfg
somepackage=0.6.2 # was: 0.5.0
otherpackage=0.1.2 # was: 0.1.1
If you provide a blacklist file, such as `blacklist.cfg` containing bad
versions, such as::
somepackage=0.6.2
somepackage=0.6.1
Then these versions won't be suggested::
$ checkversions -v -l 1 versions.cfg -b blacklist.cfg
# Checking buildout file versions.cfg
somepackage=0.6.0 # was: 0.5.0
otherpackage=0.1.2 # was: 0.1.1
If you enable the `--incremental` option, only one upgrade will be suggested::
$ checkversions --incremental -v -l 1 versions.cfg
# Checking buildout file versions.cfg
somepackage=0.6.0 # was: 0.5.0
otherpackage=0.1.1
Run tests
=========
Uncompress the archive, then run::
$ virtualenv .
$ bin/pip install tox
$ tox
Changelog
=========
2.1 (2023-02-06)
----------------
- Fix parsing of versions that are really requirements specifications.
(`#24 <https://github.com/zopefoundation/z3c.checkversions/issues/24>`_)
2.0 (2023-02-14)
----------------
- Add support for Python 3.10, 3.11.
- Drop support for Python 2.7, 3.5, 3.6.
- Pin ``setuptools < 66`` as newer versions are no longer compatible.
1.2 (2020-04-13)
----------------
- Add support for Python 3.8, drop support for Python 3.4.
- Improve error message in case zc.buildout is not installed.
- Improve installation instruction.
- Pass the index url to both the 'installed' and 'buildout' checkers.
1.1 (2018-11-03)
----------------
- Add support for Python 3.7.
- Drop support for `python setup.py test`.
1.0 (2018-05-23)
----------------
- Fix compatibility with setuptools 39 by using an API introduced
in setuptools 8. (`GH #8`_)
- Add support for Python 3.5, 3.6 and PyPy3.
- Drop support for Python 2.6 and 3.3.
- Standardize namespace ``__init__``.
.. _GH #8 : https://github.com/zopefoundation/z3c.checkversions/issues/8
0.5 (2014-09-15)
----------------
- Python 3 support by Nicolas Dietrich (`GH #2`_, `GH #4`_)
.. _GH #2: https://github.com/zopefoundation/z3c.checkversions/pull/2
.. _GH #4: https://github.com/zopefoundation/z3c.checkversions/pull/4
0.4.2 (2013-10-02)
------------------
- ignore installed packages while searching for new versions, only look in
the package index (makes the test suite more reliable, among other things).
- fix IndexError: list index out of range when buildout.cfg had a package with
a blank version pin.
- show updates for non-final package versions, if there's a newer non-final
version available on PyPI (`GH #1`_)
.. _GH #1: https://github.com/zopefoundation/z3c.checkversions/pull/1
0.4.1 (2010-08-25)
------------------
- fixed edge case bug where 1.0 was never updated to 1.0.x
- warn buildout users about the extra requirement
0.4 (2010-07-26)
----------------
- added a `blacklist` option for passing versions to avoid
(possibly coming from a buildbot)
- added a `incremental` option to suggest only one upgrade
- remove a temporary file during tests
0.3 (2010-07-09)
----------------
- don't accumulate old comments
- prefer final versions
0.2 (2010-05-22)
----------------
- added a verbose option to print old versions as well
- updated metadata, doc and license
0.1 (2010-05-16)
----------------
- Initial release
Raw data
{
"_id": null,
"home_page": "https://github.com/zopefoundation/z3c.checkversions",
"name": "z3c.checkversions",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "version,buildout,packages,upgrade,zope,ztk",
"author": "Zope Foundation and Contributors",
"author_email": "zope-dev@zope.dev",
"download_url": "https://files.pythonhosted.org/packages/b3/f5/5b5be80e3fb9b07e8ba205d82d38bbc2a1a899b1c2a0f792751184dd0818/z3c.checkversions-2.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\nFind newer versions of your installed Python packages, or newer versions of\npackages in a buildout file.\n\nThis package provides a console script named ``checkversions``.\n\n.. image:: https://github.com/zopefoundation/z3c.checkversions/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/zopefoundation/z3c.checkversions/actions/workflows/tests.yml\n\n.. contents::\n\nInstall\n=======\n\nyou can install this package either in a virtualenv::\n\n $ virtualenv sandbox\n $ sandbox/bin/pip install z3c.checkversions\n $ sandbox/bin/checkversions --help\n\nor in your system::\n\n $ sudo pip install z3c.checkversions\n $ checkversions --help\n\nor in a buildout::\n\n [buildout]\n parts = checkversions\n\n [checkversions]\n recipe=zc.recipe.egg\n eggs=z3c.checkversions [buildout]\n\nNote that buildout support is optional and must be enabled with [buildout] so\nthat zc.buildout is installed as well.\n\nIf you need buildout support while installing this package via pip\nyou have to install it like this:\n\n pip install z3c.checkversions[buildout]\n\nUsage\n=====\n\n::\n\n $ checkversions -h\n Usage: checkversions [-v] [-1] [-l LEVEL] [-i INDEX] [-b BLACKLIST] [buildout_file]\n\n This script will check new package versions of either your current installed\n distributions or a buildout file if provided. It can detect major or minor\n versions availability: level 0 gets the highest version (X.y.z), level 1 gets\n the highest intermediate version (x.Y.z), level 2 gets the highest minor\n version (x.y.Z). Using level 2, you can automatically retrieve all bugfix\n versions of a buildout. If you provide a blacklist file with bad versions,\n these versions won't be suggested.\n\n Options:\n -h, --help show this help message and exit\n -l LEVEL, --level=LEVEL\n Version level to check\n -i INDEX, --index=INDEX\n Provide and alternative package index URL\n -b BLACKLIST, --blacklist=BLACKLIST\n Provide a blacklist file with bad versions\n -1, --incremental Suggest only one upgrade. Skip others.\n -v, --verbose Verbose mode (prints old versions too)\n\n\nExamples\n========\n\nFor installed packages\n----------------------\n\nExample with a virtualenv::\n\n $ virtualenv --no-site-packages sandbox\n $ sandbox/bin/pip install z3c.checkversions\n $ sandbox/bin/checkversions -v -l 1\n # Checking your installed distributions\n pip=0.7.1 # was: 0.6.3\n\nFor a buildout\n--------------\n\nIt can work either with a full buildout.cfg or with a simple versions.cfg file.\n\nHere is a sample `versions.cfg` file::\n\n [versions]\n somepackage=0.5.3\n otherpackage=0.1.1\n\nYou can generate a new versions.cfg ::\n\n $ checkversions -v -l 1 versions.cfg\n # Checking buildout file versions.cfg\n somepackage=0.6.2 # was: 0.5.0\n otherpackage=0.1.2 # was: 0.1.1\n\nIf you provide a blacklist file, such as `blacklist.cfg` containing bad\nversions, such as::\n\n somepackage=0.6.2\n somepackage=0.6.1\n\nThen these versions won't be suggested::\n\n $ checkversions -v -l 1 versions.cfg -b blacklist.cfg\n # Checking buildout file versions.cfg\n somepackage=0.6.0 # was: 0.5.0\n otherpackage=0.1.2 # was: 0.1.1\n\nIf you enable the `--incremental` option, only one upgrade will be suggested::\n\n $ checkversions --incremental -v -l 1 versions.cfg\n # Checking buildout file versions.cfg\n somepackage=0.6.0 # was: 0.5.0\n otherpackage=0.1.1\n\n\nRun tests\n=========\n\nUncompress the archive, then run::\n\n $ virtualenv .\n $ bin/pip install tox\n $ tox\n\nChangelog\n=========\n\n2.1 (2023-02-06)\n----------------\n\n- Fix parsing of versions that are really requirements specifications.\n (`#24 <https://github.com/zopefoundation/z3c.checkversions/issues/24>`_)\n\n\n2.0 (2023-02-14)\n----------------\n\n- Add support for Python 3.10, 3.11.\n\n- Drop support for Python 2.7, 3.5, 3.6.\n\n- Pin ``setuptools < 66`` as newer versions are no longer compatible.\n\n\n1.2 (2020-04-13)\n----------------\n\n- Add support for Python 3.8, drop support for Python 3.4.\n\n- Improve error message in case zc.buildout is not installed.\n\n- Improve installation instruction.\n\n- Pass the index url to both the 'installed' and 'buildout' checkers.\n\n\n1.1 (2018-11-03)\n----------------\n\n- Add support for Python 3.7.\n\n- Drop support for `python setup.py test`.\n\n\n1.0 (2018-05-23)\n----------------\n\n- Fix compatibility with setuptools 39 by using an API introduced\n in setuptools 8. (`GH #8`_)\n\n- Add support for Python 3.5, 3.6 and PyPy3.\n\n- Drop support for Python 2.6 and 3.3.\n\n- Standardize namespace ``__init__``.\n\n.. _GH #8 : https://github.com/zopefoundation/z3c.checkversions/issues/8\n\n\n0.5 (2014-09-15)\n----------------\n\n- Python 3 support by Nicolas Dietrich (`GH #2`_, `GH #4`_)\n\n.. _GH #2: https://github.com/zopefoundation/z3c.checkversions/pull/2\n.. _GH #4: https://github.com/zopefoundation/z3c.checkversions/pull/4\n\n0.4.2 (2013-10-02)\n------------------\n\n- ignore installed packages while searching for new versions, only look in\n the package index (makes the test suite more reliable, among other things).\n- fix IndexError: list index out of range when buildout.cfg had a package with\n a blank version pin.\n- show updates for non-final package versions, if there's a newer non-final\n version available on PyPI (`GH #1`_)\n\n.. _GH #1: https://github.com/zopefoundation/z3c.checkversions/pull/1\n\n0.4.1 (2010-08-25)\n------------------\n\n- fixed edge case bug where 1.0 was never updated to 1.0.x\n- warn buildout users about the extra requirement\n\n0.4 (2010-07-26)\n----------------\n\n- added a `blacklist` option for passing versions to avoid\n (possibly coming from a buildbot)\n- added a `incremental` option to suggest only one upgrade\n- remove a temporary file during tests\n\n0.3 (2010-07-09)\n----------------\n\n- don't accumulate old comments\n- prefer final versions\n\n0.2 (2010-05-22)\n----------------\n\n- added a verbose option to print old versions as well\n- updated metadata, doc and license\n\n0.1 (2010-05-16)\n----------------\n\n- Initial release\n",
"bugtrack_url": null,
"license": "ZPL 2.1",
"summary": "Find newer package versions on PyPI",
"version": "2.1",
"project_urls": {
"Homepage": "https://github.com/zopefoundation/z3c.checkversions"
},
"split_keywords": [
"version",
"buildout",
"packages",
"upgrade",
"zope",
"ztk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "86b28fdc0d87000cb0b31248d2f81f00053dc130325d1275769d6add95dd52e9",
"md5": "7790f3372d74efe4916dde96710494e7",
"sha256": "3a5b1465b90599c76bf42cead1758465d952038779433dbd91c5e687adeabc38"
},
"downloads": -1,
"filename": "z3c.checkversions-2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7790f3372d74efe4916dde96710494e7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 17185,
"upload_time": "2023-06-02T14:32:12",
"upload_time_iso_8601": "2023-06-02T14:32:12.306238Z",
"url": "https://files.pythonhosted.org/packages/86/b2/8fdc0d87000cb0b31248d2f81f00053dc130325d1275769d6add95dd52e9/z3c.checkversions-2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b3f55b5be80e3fb9b07e8ba205d82d38bbc2a1a899b1c2a0f792751184dd0818",
"md5": "94311241d0cf178597650f96d629a539",
"sha256": "8f94a8e344b225fed77c2cf73fd60547feb3f78ba9dcb636fdd7c49a621bc409"
},
"downloads": -1,
"filename": "z3c.checkversions-2.1.tar.gz",
"has_sig": false,
"md5_digest": "94311241d0cf178597650f96d629a539",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 15829,
"upload_time": "2023-06-02T14:32:14",
"upload_time_iso_8601": "2023-06-02T14:32:14.218373Z",
"url": "https://files.pythonhosted.org/packages/b3/f5/5b5be80e3fb9b07e8ba205d82d38bbc2a1a899b1c2a0f792751184dd0818/z3c.checkversions-2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-02 14:32:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zopefoundation",
"github_project": "z3c.checkversions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "z3c.checkversions"
}
JSON
