3 # Copyright (C) 2012 W. Trevor King
5 # This file is part of update-copyright.
7 # update-copyright is free software: you can redistribute it and/or
8 # modify it under the terms of the GNU General Public License as
9 # published by the Free Software Foundation, either version 3 of the
10 # License, or (at your option) any later version.
12 # update-copyright is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with update-copyright. If not, see
19 # <http://www.gnu.org/licenses/>.
21 """Update copyright information with information from the VCS repository.
23 Run from the project's repository root.
25 Replaces every line starting with ``^# Copyright`` and continuing with
26 ``^#`` with an auto-generated copyright blurb. If you want to add
27 ``#``-commented material after a copyright blurb, please insert a blank
28 line between the blurb and your comment, so the next run of
29 ``update_copyright.py`` doesn't clobber your comment.
31 If no files are given, a list of files to update is generated
35 import logging as _logging
37 from update_copyright import LOG as _LOG
38 from update_copyright.project import Project
41 if __name__ == '__main__':
45 usage = "%%prog [options] [file ...]"
47 p = optparse.OptionParser(usage=usage, description=__doc__)
48 p.add_option('--config', dest='config', default='.update-copyright.conf',
49 metavar='PATH', help='path to project config file (%default)')
50 p.add_option('--no-authors', dest='authors', default=True,
51 action='store_false', help="Don't generate AUTHORS")
52 p.add_option('--no-files', dest='files', default=True,
53 action='store_false', help="Don't update file copyrights")
54 p.add_option('--no-pyfile', dest='pyfile', default=True,
55 action='store_false', help="Don't update the pyfile")
56 p.add_option('--dry-run', dest='dry_run', default=False,
57 action='store_true', help="Don't make any changes")
58 p.add_option('-v', '--verbose', dest='verbose', default=0,
59 action='count', help='Increment verbosity')
60 options,args = p.parse_args()
62 _LOG.setLevel(max(0, _logging.ERROR - 10*options.verbose))
65 project.load_config(open(options.config, 'r'))
67 project.update_authors(dry_run=options.dry_run)
69 project.update_files(files=args, dry_run=options.dry_run)
71 project.update_pyfile(dry_run=options.dry_run)