plone.versioncheck 1.6.3

.. This README is meant for consumption by humans and PyPI.
PyPI can render rst files so please do not use Sphinx features.
If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide_addons.html
This text does not appear on PyPI or github.
It is a comment.


=============================================================================
Checks pinned versions with overrides in a cascaded buildout
=============================================================================

.. image:: https://coveralls.io/repos/github/plone/plone.versioncheck/badge.svg?branch=master
:target: https://coveralls.io/github/plone/plone.versioncheck?branch=master


**plone.versioncheck**

.. contents::

Features
========

1) **Checks buildouts ``[versions]`` sections** while stepping through the cascaded ``extends``

- command line script collects the inherited version pins, remembers where a version pin comes from.
- It displays the result in order to enable a human to check that pins and overrides are OK.
- Output is colored; this helps to identify packages which have newer versions available.
- Machine readable output as JSON on demand.

2) **Checks Python Package Index (PyPI)** for newer versions.

- Detects if a newer major, minor or bugfix (or a prerelease) is available.

3) **Buildout extension** records the **current versions state** and **requirements**

- versions state and requirements are written to a file,
- versions from the file will be consumed by the command line tool
- orphaned version pins are detected,
- it shows which package pulled in another package as dependency.

It works best with `semantically <http://semver.org/>`_ and only with `syntactically <https://setuptools.readthedocs.io/en/latest/setuptools.html#specifying-your-project-s-version>`_ correct version numbers!

Usage
=====

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 =
...
ploneversioncheck
...

...

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

...


Run buildout as usual.

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] [-N] [-r] [-d] [-i] [-m] [--no-cache] [-b]
[-o [OUTPUT]] [--no-colors] [--debug-limit DEBUG_LIMIT]
[buildout]

Fetch information about pinned versions and its overrides in simple 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
-N, --newer-orphaned display orphaned packages only when newer versions
available
-r, --required-by show information about requirements (only if tracking
file is available)
-d, --show-release-dates
show information about release dates (only for package
lookup from PyPI)
-i, --ignore-tracking
ignore tracking file (if present)
-m, --machine show as machine readable output (json)
--no-cache do not use a cache for PyPI
-b, --browser show as html for webbrowser
-o [OUTPUT], --output [OUTPUT]
safe output to output-file
--no-colors do not show colors
--debug-limit DEBUG_LIMIT
Limit the number of PyPI versions fetched for
debugging

States and color codes:
[A]ctive (white)
[D]evelop (green)
[O]rphaned (magenta)
[I]nherited (older or same versions are gray, newer are yellow)
[U]pdate of final release on PyPI available (cyan)
[P]rerelease update on PyPI available (blue)
[X] unpinned (red)
[r] Requirement (gray)
[a] Annotation (gray)

Color of package name helps to indicate overall state of a package.


Files created
-------------

If the script was used with the ``--pypi`` option, a directory ``.plone.versioncheck.cache`` will be created.
It contains the cache of the requests to PyPI or external buildout configuration files.
To clear the cache, remove the directory.
The caching library uses the expiration headers of the response from PyPI, so even with cache it starts fetching new records.

If the extension was used, a file ``.plone.versioncheck.tracked.json`` will be created.
It contains the information from last buildout run.


Output explained
================

Legend of states and colors
---------------------------

[D]evelopment Egg
A development egg is usually active.
Description shows 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, the pin color is gray; if newer, it is yellow.

[O]rphaned
If tracked, it shows whether 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 continuous 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 update 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.

[a] Annotation
It is possible to annotate the reason why a version was chosen.
The information is parsed out of a section ``[versionannotations]``.
In this section key is the name of the package and value the text annotations to be displayed.
The value can span more than one line using indent (as usal).


Order of versions
-----------------

Order of versions is the buildout resolution order (how they are resolved by buildout in the extends chain/tree).
After that, the PyPI releases are shown (major, minor, pre, then the prereleases)

Example, given in each a version of ``my.pkg`` was declared:

1. ``buildout.cfg`` with ``my.pkg=3.0.3``

1. ``buildout.cfg`` extends ``foo.cfg`` with ``my.pkg=3.0.1``

2. ``buildout.cfg`` extends ``bar.cfg`` with ``my.pkg=2.0``

2. ``foo cfg`` extends ``baz.cfg`` with ``my.pkg=3.1``

2. found a newer versions at pypi

1. major ``my.pkg=4.0``

2. minor ``my.pkg=3.2``

3. major ``prerelease my.pkg=5.1b2``

Output looks like so::

my.pkg
3.0.3............... A buildout.cfg
2.0 ................ I bar.cfg
3.0.1 .............. I foo.cfg
3.1 ................ I baz.cfg
4.0 ................ U Major
3.2 ................ U Minor
5.1b2............... P Majorpre



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 ...]

Source Code and Contributions
=============================

.. image:: https://travis-ci.org/plone/plone.versioncheck.svg?branch=master
:target: https://travis-ci.org/plone/plone.versioncheck

If you want to help with the development (improvement, update, bug-fixing, ...) of ``plone.versioncheck`` this is a great idea!

Please follow the `contribution guidelines <http://docs.plone.org/develop/coredev/docs/guidelines.html>`_.

- `Source code at Github <https://github.com/plone/plone.versioncheck>`_
- `Issue tracker at Github <https://github.com/plone/plone.versioncheck>`_

Maintainer of ``plone.versioncheck`` is Jens Klein and the Plone contributors.
We appreciate any contribution and if a release is needed to be done on PyPI, please just contact one of us (best by open an issue).

Development
===========

There must be ``python`` with ``virtualenv`` and ``pip`` available in system path pointing to Python >=2.7.x
Clone the project. Then::

$ bootstrap.sh

For non-unix systems please read the contents of bootstrap.py and execute the steps manually adapted to your OS.

License
=======

The project is licensed under the GPLv2.


Changelog
=========

1.6.3 (2017-05-05)
------------------

- Fixes #17: Requirements were missing.
[jensens]

- Optimization: Reduce load on PyPI when fetching release dates.
[jensens]

- Feature: Change package and version fields in html output to links so that you could open pypi page for each package.
[loechel]


1.6.2 (2017-04-12)
------------------

- Fix: Regressions with version-annotations and stdout messages from buildout parser.
[loechel]

- Add more Tests
[loechel]

1.6.1 (2017-04-07)
------------------

- Fix: #36 New buildout parser does not work with buildout.coredev
[loechel]

1.6.0 (2017-04-07)
------------------

- Fix: ``IndexError: string index out of range`` error with empty states in the formatter.
[thet]

- Development: Added basic tests to package.
[loechel]

- Fix: Changed parser.py to use functions from zc.buildout to get versions and versionannotations section names.
[loechel]

- Feature: Add function to extract date information from PyPI to analyze package age.
[loechel]

- Feature: Add new CLI options for an output file and show release dates.
[loechel]

1.5.1 (2017-01-23)
------------------

- Fix Version Compare.
[loechel]

1.5.0 (2016-10-15)
------------------

- Development: Use code analysis for QA (and fix issues with pep8 et al.)
[jensens]

- Fix: Manifest (jinja file was missing).
[jensens]

- Feature: Implement #25: Annotate versions used.
[jensens]


1.4 (2016-09-30)
----------------

- Feature:
New option '-N': feature to hide orphaned without updates.
This reduces the noise in a environment where orphaned are used by intend.
[jensens]


1.3 (2016-05-19)
----------------

- Development: Add .editorconfig File to maintain code convetions following Plone API
[loechel]

- Feature: Add Support for Python 3
[loechel]

- Fix: Various documentation typos.
[jean]

1.2.1 (2016-01-26)
------------------

- Feature: Cache buildout cfg files fetched over the network.
[jensens]

- Feature: It caches now responses from PyPI.
[jensens]


1.1.2 (2016-01-21)
------------------

- Fix: Resolution order buildout extends chain was wrong. Also documented the
resolution order and included in own builodut a small example.
[jensens]

- Fix: Formatter printed a newline to much after ``required by``.
[jensens]

- Fix: Do not complain about missing track file. If it is not there,
the buildout is simply not using the buildout extension. [maurits]

- Fix #13: Added missing ``zc.buildout`` requirement. [maurits]


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]