A simple, machine-readable file to describe the license of all files in a folder and its sub-folders.

zPlus aab2d6147a Change dependencies. 5 months ago
example 61874ef8d8 Add license summary. 5 months ago
.license fae5304304 pre-alpha 5 months ago
README.md aab2d6147a Change dependencies. 5 months ago
dotlicense 61874ef8d8 Add license summary. 5 months ago

README.md

What

A simple, machine-readable file to describe the license of all files in a folder and its sub-folders.

Why

  • (hopefully) automate license verification
  • check if all files in a repository are free
  • check if any file does not have a license
  • describe license of binary files (jpg, pdf, ...) that are harder to modify
  • it's useful for me, maybe it can be useful to others too :)

Where

Just create a file called .license in your project's root folder.

How

Dependencies

  • python3-yaml
  • python3-docopt

Basic usage

Once you have created the .license file, define a license for the project:

license:   GPL-3.0-or-later
copyright: Mr. Foo Bar <mailto:foobar@example.org>

Advanced usage

The .license file contains a list of copyright statements, one after the other. Every statement is an exception to all the previous ones, and thus replace any previous definition:

license:   GPL-3.0-or-later
copyright: Mr. Foo Bar <foobar@example.org>

---

files: docs/*.jpg
license: CC-BY-SA-4.0
copyright:
    - 1997-2000 Alice <alice@example.org>
    - 2001-2010 Bob <bob@example.org>

More examples

See example folder for a demo.

Who