rosdoc::licenseindex Namespace Reference

Functions
def	_check_contaminated
	check to see if bsd package is contaminated by GPL
def	_generate_licenses_map
	build up map of packages by license
def	generate_license_index
	Generate index of packages by license.
def	li_license_links
Variables
list	_already_unknown = []
list	bsdstyle = ['bsd', 'bsd-style', 'new bsd', 'bsd (new)', 'zlib', 'zlib-style', 'mit', 'wxwindows', 'lgpl', 'free', 'python', 'python-style', 'bsl1.0', 'boost', 'apache', 'apache license, version 2.0', 'boost software license', 'public domain', 'apache license', 'BSD, Boost Software License (Poco)', 'BSD, Boost']
dictionary	canonicalize
string	contam_suffix = " (contaminated)"
list	contaminated = ['gpl', 'creativecommons-by-nc-sa-2.0', 'commercial', 'proprietary']
tuple	license_template = load_tmpl('license-index.html')
dictionary	license_urls
	all keys must be lower case

---

Function Documentation

def rosdoc::licenseindex::_check_contaminated	(		package,
			license,
			manifests
	)			[private]

check to see if bsd package is contaminated by GPL

Returns:

str, [str]: license, blamelist

Definition at line 90 of file licenseindex.py.

def rosdoc::licenseindex::_generate_licenses_map

(

ctx

)

[private]

build up map of packages by license

Returns:

license_map, blame_list: {license: [packages]}, {package: package}

Definition at line 113 of file licenseindex.py.

def rosdoc::licenseindex::generate_license_index

(

ctx

)

Generate index of packages by license.

Definition at line 160 of file licenseindex.py.

def rosdoc::licenseindex::li_license_links	(		packages,
			blamelist,
			docdir
	)

Parameters:

packages

[str]: list of packages to generate 'li' html links to

Definition at line 149 of file licenseindex.py.

---

Variable Documentation

list rosdoc::licenseindex::_already_unknown = []

Definition at line 62 of file licenseindex.py.

list rosdoc::licenseindex::bsdstyle = ['bsd', 'bsd-style', 'new bsd', 'bsd (new)', 'zlib', 'zlib-style', 'mit', 'wxwindows', 'lgpl', 'free', 'python', 'python-style', 'bsl1.0', 'boost', 'apache', 'apache license, version 2.0', 'boost software license', 'public domain', 'apache license', 'BSD, Boost Software License (Poco)', 'BSD, Boost']

Definition at line 59 of file licenseindex.py.

dictionary rosdoc::licenseindex::canonicalize

Initial value:

{
    'lgpl': 'LGPL',
    'unknown': 'Unknown',
    'BSD and GPL': 'BSD/GPL',
    'Commercial': 'Proprietary',
    'Closed': 'Commercial',
    'BSD.': 'BSD',
    'new BSD': 'BSD (new)', #for better alphabetizing
    'GPL v3': "GPLv3",
    'GNU GPL V3': 'GPLv3',
    'GPL 3.0': 'GPLv3',
    '?': 'Unknown',
    }

Definition at line 45 of file licenseindex.py.

string rosdoc::licenseindex::contam_suffix = " (contaminated)"

Definition at line 64 of file licenseindex.py.

list rosdoc::licenseindex::contaminated = ['gpl', 'creativecommons-by-nc-sa-2.0', 'commercial', 'proprietary']

Definition at line 60 of file licenseindex.py.

tuple rosdoc::licenseindex::license_template = load_tmpl('license-index.html')

Definition at line 83 of file licenseindex.py.

dictionary rosdoc::licenseindex::license_urls

Initial value:

{
    'boost': 'http://www.boost.org/users/license.html',
    'bsl1.0': 'http://www.boost.org/LICENSE_1_0.txt',
    'boost software license': 'http://www.boost.org/users/license.html',
    'mit': 'http://www.opensource.org/licenses/mit-license.php',
    'new bsd': 'http://www.opensource.org/licenses/bsd-license.php',
    'bsd': 'http://www.opensource.org/licenses/bsd-license.php',
    'zlib': 'http://www.gzip.org/zlib/zlib_license.html',
    'lgpl': 'http://www.opensource.org/licenses/lgpl-2.1.php',
    'lgplv3': 'http://www.opensource.org/licenses/lgpl-3.0.html',
    'gpl': 'http://www.opensource.org/licenses/gpl-2.0.php',
    'gplv3': 'http://www.opensource.org/licenses/gpl-3.0.html',
    'nosa': 'http://www.opensource.org/licenses/nasa1.3.php',
    'creativecommons-by-nc-sa-2.0': 'http://creativecommons.org/licenses/by-nc-sa/2.0/',
    }

all keys must be lower case

Definition at line 67 of file licenseindex.py.