plone.versioncheck 1.1.1

Install with your buildout

Add a section to install it as a script and add it as an extension to your builodut:

[buildout]
...
extensions =
    plone.versioncheck

parts =
    ...
    versioncheck
    ...

...

[versioncheck]
recipe = zc.recipe.egg
eggs = plone.versioncheck

...

Run buildout as usal.

Now a file .plone.versioncheck.tracked.json was generated in the buildout-directory.

This file will be used by bin/versioncheck to figure out which packages were finally used.

Run buildout again to regenerate this file.

commandline

usage: versioncheck [-h] [-p] [-n] [-r] [-i] [-m] [--no-colors]
                    [--debug-limit DEBUG_LIMIT]
                    [buildout]

Fetch information about pinned versions and its overrides insimple and complex/cascaded buildouts.

positional arguments:
  buildout              path to buildout.cfg or other *.cfg file

optional arguments:
  -h, --help            show this help message and exit
  -p, --pypi            check pypi for newer versions
  -n, --newer           display only packages with newer version than active
  -r, --required-by     show information about requirements (only if tracking
                        file is available)
  -i, --ignore-tracking
                        ignore tracking file (if present)
  -m, --machine         show as machine readable output (json)
  --no-colors           do not show colors
  --debug-limit DEBUG_LIMIT
                        Limit the number of pypi versions fetched for
                        debugging

[...]

Legend of states and colors

[D]evelopmen Egg

A development egg is usally active. Description show location. Color: Green

[A]ctive Pin

Pinned version. Package is used and recent, all seems fine. Color: White

[I]nherited Pin

unused pin. If older than active pin color is gray, if newer yellow.

[O]rphaned

If tracked, it shows if the package in the given configuration was used at all. Be careful with this information! I.e. in a development buildout file other packages are used than in a live or continious integration buildout! Color: Magenta

[X] Unpinnend

Tracked, but no pin in versions sections were found. Color: Red

[U]pdate final release

At PyPI there is a newer final version available (major, minor or bugfix). Descriptions shows on which level. Color: Cyan

[P]rerelease update

At PyPI there is a newer prerelease version available (major, minor or bugfix). Descriptions shows on which level. Only if there is no final release updatye available. Color: Blue

[R] Required by

If tracked and option --required-by was given, show packages this package is required by. Valid for current active/ used version. Keep in mind this is based on the declared requirements, missing or implicit requirements are not covered.

Example

Here w/o colors, run on buildout.coredev:

$ ./bin/versioncheck -p buildout.cfg

accesscontrol
    3.0.12 .... A versions.cfg
    2.13.13 ... I http://dist.plone.org/versions/zope-2-13-23-versions.cfg
acquisition
    4.2.2 ..... A versions.cfg
    2.13.9 .... I http://dist.plone.org/versions/zope-2-13-23-versions.cfg
alabaster
    0.7.7 ..... X unpinned
archetypes.multilingual
    3.0.1 ..... A versions.cfg
archetypes.referencebrowserwidget
    2.5.6 ..... A versions.cfg
archetypes.schemaextender
    2.1.5 ..... A versions.cfg
argcomplete
    1.0.0 ..... A tests.cfg
argh
    0.26.1 .... A tests.cfg
argparse
    (unset) ... A versions.cfg
    1.1 ....... I http://dist.plone.org/versions/zopetoolkit-1-0-8-ztk-versions.cfg
    Can not check legacy version number.  U Error
autopep8
    1.2.1 ..... A tests.cfg

[... skipped a bunch ...]

coverage
    3.7.1 ..... A tests.cfg
    3.5.2 ..... I http://dist.plone.org/versions/zopetoolkit-1-0-8-ztk-versions.cfg
    4.0.3 ..... U Major
    4.1b1 ..... P Majorpre
cssmin
    0.2.0 ..... A versions.cfg
cssselect
    0.9.1 ..... A versions.cfg
datetime
    3.0.3 ..... A versions.cfg
    2.12.8 .... I http://dist.plone.org/versions/zope-2-13-23-versions.cfg
    4.0.1 ..... U Major
decorator
    4.0.6 ..... A versions.cfg

[... skipped a bunch ...]

plone.app.textfield
    1.2.6 ..... A versions.cfg
plone.app.theming
    1.2.17.dev0  D /home/workspacejensens/coredev5/src/plone.app.theming/src
    1.2.16 .... I versions.cfg
plone.app.tiles
    2.1.0 ..... A versions.cfg
    2.2.0 ..... U Minor

[... skipped a bunch ...]

1.1.1 (2016-01-20)

• Fix: Orphan detection failed when no tracking file was present. [jensens]

• Fix: Exception raised when no tracking file was present. [jensens]

• Fix: Color of requirements was not set explicitly. [jensens]

1.1 (2016-01-19)

• Enhancement: show requirements [jensens]

• Enhancement: machine readable output (json) [jensens]

• Enhancement: write pure processing-info output to sys.stderr [jensens]

• Fix #5 - Require setuptools>=12 [jensens]

• Fix #7 - Available update from ‘lazy’ 1.0 to 1.2 is not found. [jensens]

• Enhancement: Rethink colors and document them, fixes #2 and #3. [jensens]

• Enhancement: display output and show tracked info [jensens]

• Feature: Add buildout extension to optional track required by and if its use at all [jensens]

1.0 (2016-01-13)

• Initial work. [jensens]