lic-check’s documentation

Contents:

lic-check

Provides FOSS compatibile licenses when give license to a new project.

Status

https://secure.travis-ci.org/mkouhei/lic-check.png?branch=master https://coveralls.io/repos/mkouhei/lic-check/badge.png?branch=master Documentation Status

Requirements

  • Python 2.7 or Python 3.3 over

Features

  • License classifiers

Setup

$ pip install --user lic-check
or
(venv)$ pip install lic-check

Usage

$ python
>>> from lic_check.classifier import Classifier
>>> c = Classifier()
>>> c.segments
[SoftwareLicenses, DocumentationLicenses, OtherLicenses]

References

lic_check.define.

class lic_check.classifier.Category(element, segment)

Bases: object

License Category.

  • GPL compatible licenses
  • GPL incompatible licenses
  • Nonfree Software licenses
class lic_check.classifier.Classifier

Bases: object

classify verious licences.

>>> c = Classifier()
>>> c.segments
[SoftwareLicenses, DocumentationLicenses, OtherLicenses]
>>> c.segments[0].categories
[GPLCompatibleLicenses, GPLIncompatibleLicenses, NonFreeSoftwareLicenses]
>>> c.segments[0].categories[0].licenses
[GNUGPLv3, GPLv2, LGPLv3, LGPLv2.1, AGPLv3.0, ...
categories(segment=None)

categories.

>>> c = Classifier()
>>> c.categories(c.segments[0])
[GPLCompatibleLicenses, GPLIncompatibleLicenses, NonFreeSoftware...
>>> c.categories(c.segments[1])
[FreeDocumentationLicenses, NonFreeDocumentationLicenses]
>>> c.categories(c.segments[2])
[OtherLicenses, Fonts, OpinionLicenses, Designs]
>>> c.categories().get('SoftwareLicenses')
[GPLCompatibleLicenses, GPLIncompatibleLicenses, NonFreeSoftware...
>>> c.categories().get('DocumentationLicenses')
[FreeDocumentationLicenses, NonFreeDocumentationLicenses]
licenses(category=None)

licenses.

>>> c = Classifier()
>>> sw_lic = c.segments[0]
>>> gpl_compat_lic = c.categories(sw_lic)[0]
>>> gpl_compat_lics = c.licenses(gpl_compat_lic)
>>> len(gpl_compat_lics)
50
>>> gpl_compat_lics[0]
GNUGPLv3
>>> gpl_compat_lics[0].category
GPLCompatibleLicenses
>>> gpl_compat_lics[0].segment
SoftwareLicenses
>>> gpl_incompat_lic = c.categories(c.segments[0])[1]
>>> c.licenses(gpl_incompat_lic)
[AGPLv1.0, AcademicFreeLicense, apache1.1, ...
>>> nonfree_lic = c.categories(sw_lic)[2]
>>> c.licenses(nonfree_lic)
[NoLicense, Aladdin, apsl1, ...
>>> c.licenses().get('GPLCompatibleLicenses')
[GNUGPLv3, GPLv2, LGPLv3, LGPLv2.1, AGPLv3.0, ...
class lic_check.classifier.License(element, category)

Bases: object

License.

class lic_check.classifier.Segment(element)

Bases: object

License Segmentation.

  • Software Licenses
  • Documentation licenses
  • Other works

ChangeLog

0.1.0 (2016-05-12)

  • Initial release.

Indices and tables