Automatically check the licenses of package dependencies.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Franco Masotti 000536a7a7
Preparing for new release.
2 months ago
assets Added files. 3 months ago
docs Preparing for new release. 2 months ago
examples Updated email. Added example file. 3 months ago
licheck Fixed removal of old cache. 2 months ago
.allowed_licenses.yml Added hooks. 3 months ago
.gitignore Added hooks. 3 months ago
.pre-commit-config.yaml Updated rev id. 2 months ago
.pre-commit-hooks.yaml Fixed hook. 2 months ago
CONTRIBUTING.rst First commit. 3 months ago
LICENSE.txt First commit. 3 months ago
MANIFEST.in First commit. 3 months ago
Makefile Added reproducible wheel. 2 months ago
Pipfile Preparing for new release. 2 months ago
README.rst Typo. 2 months ago
setup.py Preparing for new release. 2 months ago

README.rst

licheck

PyPI licheck version PyPI - License Buy me a coffee pre-commit

Automatically check the licenses of package dependencies.

Description

Inspired by kontrolilo, check the licenses of sotware dependencies in package managers used by developers. This program is primarly aimed to be used as a git hook with pre-commit.

Documentation

https://docs.franco.net.eu.org/licheck/

Please read carefully the External programs section of the documentation to learn which programs you need to install before licheck.

Have a look at the Configuration file section to know how to configure licheck.

API examples

licheck has a public API. This means for example that you can you easily build a TOC within another Python program. The easiest way to build one for a markdown file is:

>>> import licheck
>>> f = open('Pipfile')
>>> print(f.read(), end='')
[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true

[dev-packages]
Sphinx = "~=4.1"

[requires]
python_version = "*"
>>> binary, program = licheck.get_binary_and_program('python')
>>> command = licheck.build_command(binary, program, 'Pipfile')
>>> print(licheck.get_data(command, program))

CLI Helps

:

$ licheck --help

License

Copyright (C) 2021 frnmst (Franco Masotti) <franco.masotti@tutanota.com>

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/>.

Changelog and trusted source

You can check the authenticity of new releases using my public key.

Changelogs, instructions, sources and keys can be found at blog.franco.net.eu.org/software.

Crypto donations

  • Bitcoin: bc1qnkflazapw3hjupawj0lm39dh9xt88s7zal5mwu
  • Monero: 84KHWDTd9hbPyGwikk33Qp5GW7o7zRwPb8kJ6u93zs4sNMpDSnM5ZTWVnUp2cudRYNT6rNqctnMQ9NbUewbj7MzCBUcrQEY
  • Dogecoin: DMB5h2GhHiTNW7EcmDnqkYpKs6Da2wK3zP
  • Vertcoin: vtc1qd8n3jvkd2vwrr6cpejkd9wavp4ld6xfu9hkhh0