Configuration file

Local files

In the root of your repository create a file called .allowed_licenses.yml.

There are two possible formats for this file:

  1. use a local list of licenses directly in the file, for example:

    allowed licenses:
        - OSI Approved::BSD License
        - OSI Approved::Apache Software License
        - OSI Approved::MIT License
        - OSI Approved::GNU General Public License v3 or later (GPLv3+)
    
    files to check:
        - Pipfile
        - setup.py
    
    language: python
    
    include: []
    
  2. include a remote file, for example:

    allowed licenses: []
    
    files to check:
        - Pipfile
        - setup.py
    
    language: python
    
    include:
        - https://codeberg.org/frnmst/licheck/raw/branch/master/examples/python_gpl_compatible.yml
    

Remote files

Remote files may only contain allowed licenses values. The use of remote files is inspired by kontrolilo and license-check-config , for example:

#
# python_gpl_compatible.yml
#
# Copyright (C) 2021 frnmst (Franco Masotti) <franco.masotti@tutanota.com>
#
# This file is part of licheck.
#
# licheck is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# licheck is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with licheck.  If not, see <http://www.gnu.org/licenses/>.
#

allowed licenses:
    - OSI Approved::BSD License
    - OSI Approved::Apache Software License
    - OSI Approved::MIT License
    - OSI Approved::GNU General Public License v3 or later (GPLv3+)
    - OSI Approved::Artistic License
    - OSI Approved::Boost Software License 1.0 (BSL-1.0)
    - OSI Approved::CEA CNRS Inria Logiciel Libre License, version 2.1 (CeCILL-2.1)
    - Eiffel Forum License (EFL)
    - OSI Approved::GNU Affero General Public License v3
    - OSI Approved::GNU General Public License v2 or later (GPLv2+)
    - OSI Approved::GNU General Public License v3 (GPLv3)
    - OSI Approved::GNU General Public License v3 or later (GPLv3+)
    - OSI Approved::GNU Lesser General Public License v2 (LGPLv2)
    - OSI Approved::GNU Lesser General Public License v3 (LGPLv3)
    - OSI Approved::GNU Library or Lesser General Public License (LGPL)
    - OSI Approved::Historical Permission Notice and Disclaimer (HPND)
    - OSI Approved::ISC License (ISCL)
    - OSI Approved::Intel Open Source License
    - OSI Approved::MIT license
    - OSI Approved::Mozilla Public License 2.0 (MPL 2.0)
    - OSI Approved::Netscape Public License (NPL)
    - Public Domain
    - OSI Approved::Python Software Foundation License
    - OSI Approved::Universal Permissive License (UPL)
    - OSI Approved::University of Illinois/NCSA Open Source License
    - OSI Approved::W3C License
    - OSI Approved::Zope Public License
    - OSI Approved::zlib/libpng License

files to check: []

language: python

include: []