project: Require project/vcs

We use the configured VCS for the author list and per-file updates, so
there's nothing we can do if the user hasn't set it.  Instead of
crashing with:

  Traceback (most recent call last):
    File "./bin/update-copyright.py", line 80, in <module>
      project.update_authors(dry_run=args.dry_run)
    File "/.../update_copyright/project.py", line 162, in update_authors
      authors = self._vcs.authors()
  AttributeError: 'NoneType' object has no attribute 'authors'

Die earlier with:

  Traceback (most recent call last):
    File "./bin/update-copyright.py", line 78, in <module>
      project.load_config(open(args.config, 'r'))
    File "/home/wking/src/update-copyright/update_copyright/project.py", line 66, in load_config
      loader(parser=parser)
    File "/home/wking/src/update-copyright/update_copyright/project.py", line 89, in _load_project_conf
      raise NotImplementedError('vcs: {}'.format(vcs))
  NotImplementedError: vcs: None

We may want to add some auto-detection logic here in the future.

project: Convert parser access to use the mapping protocol

Use the more dict-like access [1] instead of the API that's specific
to ConfigParser.  This is likely to be more familiar to future
developers, and reduces the cognitive load of dealing with another
API.

The only place I couldn't drop the old API was in load_config, where I
kept parser.sections() [2] because using parser.keys() was giving me:

  AttributeError: 'Project' object has no attribute '_load_DEFAULT_conf'

The:

  try:
      section = parser['...']
  except KeyError:
      section = {}

blocks are also more awkward than a dicts:

  section = parser.get('...', {})

but we can't use that API because it's clobbered by
ConfigParser.get(section, option, ...) [3].  Maybe someday they'll
support:

  section = parser.get('...', default={})

(or with 'fallback' instead of 'default').

[1]: https://docs.python.org/3/library/configparser.html#mapping-protocol-access
[2]: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.sections
[3]: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.get

Run update-copyright.py

Bump to version 0.6.1

Changes since 0.6:
* README: update to pipe separators

README: update to pipe separators

This brings the config file up to speed with the following
update-copyright commit (which landed in 0.5):

  commit 3c68a1a48419d8b2bbc2ce0e7f1700b996ec30e9
  Author: W. Trevor King <wking@tremily.us>
  Date:   Fri Oct 19 21:52:48 2012 -0400

    project: for consistency, also separate ignored paths with pipes

Bump to version 0.6

Changes since 0.5:
* Dropped Bazaar support.
* Fixed Mercurial support for Python 3 (by shelling out to hg).
* Adjusted date ranges so the final date is the last year a file was
  patched, and not the current year.  This avoids bumping copyright
  years when there were no changes.

Run update-copyright.py

README: Update with Bazaar removal and shell-based Mercurial

vcs.mercurial: Shell out to hg instead of using the mercurial package

Mercurial doesn't have Python 3 support, and has no plans for adding
it in the near future [1].  It's a pretty painless conversion to shell
out instead (as we already do for Git), so go that route instead.

[1]: http://mercurial.selenic.com/wiki/SupportedPythonVersions#Python_3.x_support

vcs.bazaar: Remove Bazaar support

As of 2013-05-19, Bazaar had no Python 3 compatibility, and no
likelyhood of adding it in the near future [1].  This module could be
ported to use the command line client (like Git), but I also haven't
seen a Bazaar repository in a while ;).

[1]: https://answers.launchpad.net/bzr/+question/229048#comment-0

project: Replace original_year and final_year with years

Rather than automatically bumping the final year to the current year,
only bump to the last year for which a file was changed.  I've kept
the 'first-last' syntax, but

  update_copyright.utils.copyright_string

is not the only place you have to edit if you prefer to list them all
explicitly:

  Copyright (C) year-1, year-2, ..., year-n A. U. Thor ...

README: Fix .mailmap link markup

Apparently reStructuredText needs backticks here.  Maybe the leading
dot confuses it.

Bump to version 0.5

Ran update-copyright.py

setup.py: Add explicit Python 3 classifiers

update-copyright.py: add --version

update-copyright.py: Use the configured files.authors and files.files

Rather than reading them into Project.with_authors and
Project.with_files and then ignoring them.  This means that if you
don't want an AUTHOR file, you can disable it in your
.update-copyright.conf and then skip `--no-authors` on the command
line.

project: Load files.authors and files.files as booleans

Because both `bool('yes')` and `bool('no')` are True.

project: don't explicitly convert configured options to unicode strings

Python 3's ConfigParser does this for us.

project: add Project._split_paragraph().

Now we split on double-newlines, not single newlines.  This is how our
README example and internal .update-copyright.conf are formatted.

project: use (start, middle, end) prefixes in copyright_string() calls

project|utils: expand info into kwargs for format().

update-copyright.py: update from optparse to argparse

utils: convert `% (...)` formatting to `.format(...)`

project|(vcs:utils): convert  unicode() -> str().

.update-copyright.conf|README: convert %(project)s -> {project} formatting

Upgrade to Python 3.2

bzrlib and mercurial aren't Python 3 compatible yet (and seem unlikely
to become compatible in the near future), so if you're using them, you
should stick with an older version of update-copyright.

Note that the version of Python used by update-copyright has nothing
to do with the version of Python you use in your project.  You project
doesn't even have to use Python at all.

Update exception handling to use `except X as Y` syntax.

.update-copyright.conf: update to pipe separators.

This brings the config file up to speed with the following
update-copyright commit:

  commit 3c68a1a48419d8b2bbc2ce0e7f1700b996ec30e9
  Author: W. Trevor King <wking@tremily.us>
  Date:   Fri Oct 19 21:52:48 2012 -0400

    project: for consistency, also separate ignored paths with pipes

project: for consistency, also separate ignored paths with pipes.

project: for consistency, also separate alias authors with pipes.

project: use pipe symbols (|) to separate author-hack authors.

Author names may contain commas (e.g. "Red Hat, Inc."), but are
unlikely to contain pipe symbols.

vcs: adjust .original_year() relative path calculation to match .authors().

I should have fixed .authors() back when I fixed .original_year().
Now the filename handling is identical, which should make it easier
for people to keep future updates in sync.

vcs: use relative paths for matching author-hacks.

project: configured author keys should be converted to unicode.

project: preserve case in .update-copyright.conf options.

This is important for aliases in particular.

vcs:utils: some VCSs (e.g. Git) return sets of authors.

Ran update-copyright.

Change my email address from drexel.edu to tremily.us.

Move classifiers into a list in setup.py.

This avoids:
  Server response (400): Invalid classifier "<filter object at 0x28604d0>"

Bump to version 0.4

Fix reStructuredText markup for `` */`` in the README.

Use a nonbreaking space so that rst knows the first `` is the start of
a literal block.  Because I used a unicode nbsp, adjust setup.py to
appropriately import the long_description.  Note that this means
you'll have to use Python 3 for registering the package.

Add ability to handle blurbs in C-style comments.

Fix Project._ignored_file() doctest, and get it to match directories.

With the earlier implementation, adding '.git' to your ignored paths
would not protect '.git/x/y/z', which is not good ;).

Add trailing slash to Gentoo overlay link in README.

Fix line -> date typo from incomplete splitout of GitBackend._dates().

Add external command invocations to debugging output.

Split out _dates from _years in GitBackend.

This makes it easier for external modules to use the GitBackend to do
different things with the extracted list of dates.

Update download_url to point to tremily.

Remove comments from .update-copyright.conf now that the README is better.

Also move the short copyright blurb forward, so people won't have to
scroll through the long blurb to find anything interesting.

Bump to version 0.3, now that things are working on BE and Hooke.

Add ability to run on a remote root based on the config file.

For example

  update-copyright.py --config /path/to/project/.update-copyright.conf

will now update the code in `/path/to/project/` without you having to
change into that directory.

Add support for loading author_hacks, year_hacks, and aliases from the config.

Rename authors -> _authors in VCSBackend.authors() loop to avoid clobber.

The previous version had been clobbering the raw VCS results.

Fix VCSBackend.original_year() bug in applying per-file year_hacks.

The per-file value is a single integer, so use `.add` instead of `.update`.

Fix year_hacks -> self._year_hacks typo in VCSBackend.original_year().

Allow '-' characters in section names.

Make config file parsing more modular.

Improve unicode handling and increase the default textwrap width.

Use `with_emails` argument in `VCSBackend.authors()`.

Oops, `ConfigParser(interpolation=None)` belongs to Python 3.

Cleanup help strings in bin/update-copyright.py.

Flesh out the README.

Use ConfigParser instead of deprecated RawConfigParser.

Raise errors in Project if the configured backend could not be loaded.

Fix url in setup.py (tremily.us -> blog.tremily.us).

Ran update-copyright.py to update setup.py.

Add build (created by `python setup.py build`) to .gitignore.

Add setup.py for distutils packaging.

Add README to list of ignored paths in .update-copyright.conf.

With normpath, there is no need for the prefix * in my ignore globs.

Add a normpath() to files returned by list_files (less suprising this way).

Add .update-copyright.conf and .git* to ignored files.

Change maxium verbosity setting from 0 to logging.DEBUG.

Add AUTHORS and license.py to .gitignore.

Use pth instead of p when splitting ignored (don't clobber the configparser).

Log reason for ignoring paths in Project._ignore_file().

Add COPYING to list of ignored files in .update-copyright.conf.

Add comma-delimiter to list of ignored file globs in Project.load_config().

Add COPYING.

Add .gitignore.

Run update-copyright on itself.

Convert update-copyright.py to a more modular framework.

Add `filename=None` default option to Git's `original_year()`.

This had gotten lost in the previous merge.

Merge Hooke and BE branches of update-copyright.

Change VCS from Mercurial to Git in update_copyright.py.

Grr. Uncomment authors & file lines un update_copyright.py again.

Rework update_copyright and short_license to allow unwrapped paragraphs.

The GUI's about popup does it's own wrapping, so the text we send in
should be unwrapped.

Added hooke.plugin.license and removed get-warrenty info from short_license.

Also uncommented update_authors() and update_files() in
update_copyright, since I'm no longer testing the pyfile code ;).

Added pyfile output to update_copyright.py.

This creates hooke/license.py with licensing strings and functions.
I've updated the copyright blurbs in the command line startup message
and the GUI about message, but haven't actually added the advertised
'warrenty' and 'license' details yet.

Convert update_copyright.py to a more VCS-agnostic version.

This will make it easier for others to grab this code for their own
projects.  Currently supported VCSs: Git, Mercurial, Bazaar.

Fix /doc/build/ -> ./doc/build/ in update_copyright.py

Adjust update_copyright hacks to follow plugin.peakspot -> util.peak move

Use ALIASES and AUTHOR_HACKS handling in update_copyright.update_authors.

The previously generated AUTHORS file was the raw list of VCS
commiters.

Further author/year workarounds in update_copyright.py.

Add AUTHOR_HACKS and YEAR_HACKS to update_copyright.py

This works around holes in the versioning where files were initially
released before being added to the versioning system, or they were
never committed under the name of one of the authors.

Update canonical copyright names for 'illysam' and 'pancaldi.paulo'.

Also add the missing '.82' to Fabrizio's alias.

Fix some doctests in update_copyright.py.

And make some adjustments so that update_copyright.py can update its
own copyright blurb without changing anything else inside itself.

Rearrange license text and add update_copyright.py.

Following http://www.gnu.org/licenses/gpl-howto.html
  * Moved LGPLv3 text from LICENSE -> COPYING.LESSER
  * Brought in GPLv3 text -> COPYING

update_copyright.py automates the maitenance of boilerplate copyright
information at the head of every file.

Updated update_copyright to work with git/hg/bzr.

I'd added the extra VCS support when I took it over to Hooke.