frnmst
/
licheck
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity Software Blog
Automatically check the licenses of package dependencies.
68 Commits 2 Branches 4 Tags 168 KiB
Python 97.5%
Makefile 2.5%
Go to file
Franco Masotti c835fc3df5
Added missing documentation. 		2022-01-12 19:23:03 +01:00
assets Added files. 2021-07-25 23:37:18 +02:00
docs Added missing documentation. 2022-01-12 19:23:03 +01:00
examples Fixed copyright headers. Removed Python version from Pipfile. Fixed package name in makefile. Fixed dependencies. 2022-01-07 19:45:28 +01:00
licheck Fixes. 2022-01-12 19:14:15 +01:00
.allowed_licenses.yml Added hooks. 2021-07-24 23:14:44 +02:00
.gitignore Added hooks. 2021-07-24 23:14:44 +02:00
.pre-commit-config.yaml Changed a pre-commit hook URL. 2021-08-28 13:08:32 +02:00
.pre-commit-hooks.yaml Fixed hook. 2021-08-05 18:39:31 +02:00
CONTRIBUTING.rst First commit. 2021-07-18 18:12:10 +02:00
LICENSE.txt First commit. 2021-07-18 18:12:10 +02:00
MANIFEST.in First commit. 2021-07-18 18:12:10 +02:00
Makefile Fixed copyright headers. Removed Python version from Pipfile. Fixed package name in makefile. Fixed dependencies. 2022-01-07 19:45:28 +01:00
Pipfile Fixed copyright headers. Removed Python version from Pipfile. Fixed package name in makefile. Fixed dependencies. 2022-01-07 19:45:28 +01:00
README.rst Fixed copyright headers. Removed Python version from Pipfile. Fixed package name in makefile. Fixed dependencies. 2022-01-07 19:45:28 +01:00
setup.py Preparing for new release. 2022-01-12 19:04:19 +01:00

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-2022 Franco Masotti (franco DoT masotti {-A-T-} tutanota DoT 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