pombredanne / cato Goto Github PK

CATO
====

This module implements the necessary routines used to embed license
informations into source code project files.
The package installation also installs a command line utility along with the
license files in textual format in a hidden directory inside the user home.


LICENSE
=======

Cato license terms can be found in the LICENSE file distributed with the 
package.

INSTALLATION
============

after downloading the package::

    $ cd cato
    $ python setup.py install

or via pypi automatic installation::

    $ pip install cato

DOCUMENTAION
============

Developer documentation is distributed in html format along with the package,
and can be obtained running epydoc on the source code files::

    Usage: cato -l gpl-3.0 -o "John Doe" -e [email protected] -y 2012 filename.py

Cato is free software for applying licenses to your source code files. You
can customize cato changing the cato.cfg file that you find in ~/.cato/ and
adding license textual files in ~/cato/licenses/.  License files can contain
<owner> and <email> textual tags which will be replaced with cato
informations.  Embedded license versions will be applied on the first empty
line of each source file scanned, if no empty line is found, no license is
applied.  In its normal behaviour cato apply the license to the files given as
arguments on the command line, while using -d option it scans the given
directory for file extensions specified as command line arguments. If -r is
provided in conjunction with -d, all the directory tree is scanned starting
from the supplied dir.

Options::
  -h, --help            show this help message and exit
  --list                Lists available licenses and quit
  -l LICENSE, --license=LICENSE
                        The license name, use --list to list all licenses
                        available
  -o OWNER, --owner=OWNER
                        the copyright owner
  -e EMAIL, --email=EMAIL
                        email contact of the copyright owner
  -y YEAR, --year=YEAR  the copyright year, defaults to current year
  -d DIRECTORY, --directory=DIRECTORY
                        a target directory where to find sources and add a
                        LICENSE file
  -r                    only with -d. If set recursively parses directory tree
  -c COMMENT, --comment=COMMENT
                        overrides comment syntax