Package: licensecheck
LicenseCheckNOTICE: I am not a lawyer (IANAL)Any output provided by this software is for general informational purposes only and
should not be construed as legal advice. I am not a lawyer and there is no guarantee that the
information provided here is complete or correct. Any reliance on the information provided by this
software is at your own risk.See also:https://en.wikipedia.org/wiki/IANAL,project license (MIT)Output the licences used by dependencies and check if these are compatible with
the project licenseTable of ContentsExamples from the command-lineUsing requirementsFailing on packages under MIT licenseCustom requirements.txt in json formatPoetry with dev requirementsPEP 631 (with or without optional dependencies)HelpConfiguration ExampleExample 1: pyproject.tomlExample 2: licensecheck.jsonExample 3: licensecheck.iniDocumentationInstall With PIPLanguage informationBuilt forInstall Python on WindowsChocolateyWindows - Python.orgInstall Python on LinuxAptDnfInstall Python on MacOSHomebrewMacOS - Python.orgHow to runWindowsLinux/ MacOSBuildingTestingDownload ProjectCloneUsing The Command LineUsing GitHub DesktopDownload Zip FileCommunity FilesLicenceChangelogCode of ConductContributingSecuritySupportRationaleExamples from the command-lineSee below for the output if you runlicensecheckin this directory>> licensecheck

                             list of packages
┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Compatible ┃ Package             ┃ License(s)                           ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ ✔          │ urllib3             │ MIT License                          │
│ ✔          │ types-setuptools    │ Apache Software License              │
│ ✔          │ tomli               │ MIT License                          │
│ ✔          │ idna                │ BSD License                          │
│ ✔          │ Pygments            │ BSD License                          │
│ ✔          │ certifi             │ Mozilla Public License 2.0 (MPL 2.0) │
│ ✔          │ fhconfparser        │ MIT License                          │
│ ✔          │ rich                │ MIT License                          │
│ ✔          │ charset-normalizer  │ MIT License                          │
│ ✔          │ requirements-parser │ Apache Software License              │
│ ✔          │ commonmark          │ BSD License                          │
│ ✔          │ requests            │ Apache Software License              │
│ ✔          │ attrs               │ MIT License                          │
└────────────┴─────────────────────┴──────────────────────────────────────┘Using requirements>> licensecheck -u requirements

                       list of packages
┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Compatible ┃ Package             ┃ License(s)              ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ ✔          │ requirements-parser │ Apache Software License │
│ ✔          │ requests            │ Apache Software License │
│ ✔          │ rich                │ MIT License             │
│ ✔          │ fhconfparser        │ MIT License             │
│ ✔          │ tomli               │ MIT License             │
└────────────┴─────────────────────┴─────────────────────────┘Failing on packages under MIT license>> licensecheck --fail-licenses mit

                             list of packages
┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Compatible ┃ Package             ┃ License(s)                           ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ ✔          │ idna                │ BSD License                          │
│ ✔          │ certifi             │ Mozilla Public License 2.0 (MPL 2.0) │
│ ✔          │ Pygments            │ BSD License                          │
│ ✔          │ commonmark          │ BSD License                          │
│ ✔          │ requirements-parser │ Apache Software License              │
│ ✖          │ fhconfparser        │ MIT License                          │
│ ✖          │ tomli               │ MIT License                          │
│ ✔          │ types-setuptools    │ Apache Software License              │
│ ✖          │ attrs               │ MIT License                          │
│ ✖          │ charset-normalizer  │ MIT License                          │
│ ✖          │ rich                │ MIT License                          │
│ ✖          │ urllib3             │ MIT License                          │
│ ✔          │ requests            │ Apache Software License              │
└────────────┴─────────────────────┴──────────────────────────────────────┘Custom requirements.txt in json formatAdd optional path to requirements.txt as outlined inhttps://github.com/FHPythonUtils/LicenseCheck/issues/9#issuecomment-898878228. Eg.licensecheck --using requirements:c:/path/to/reqs.txt;path/to/other/reqs.txt>> licensecheck -u 'requirements:requirements.txt;requirements_optional.txt' -f json
{
	"info": {
		"program": "licensecheck",
		"version": "2022.2.0"
	},
	"packages": [
		{
			"name": "requests",
			"version": "2.28.1",
			"namever": "requests-2.28.1",
			"size": 180253,
			"homePage": "https://requests.readthedocs.io",
			"author": "Kenneth Reitz",
			"license": "Apache Software License",
			"licenseCompat": true,
			"errorCode": 0
		},
		{
			"name": "rich",
			"version": "12.6.0",
			"namever": "rich-12.6.0",
			"size": 905975,
			"homePage": "https://github.com/willmcgugan/rich",
			"author": "Will McGugan",
			"license": "MIT License",
			"licenseCompat": true,
			"errorCode": 0
		},
		{
			"name": "tomli",
			"version": "2.0.1",
			"namever": "tomli-2.0.1",
			"size": 26252,
			"homePage": "UNKNOWN",
			"author": "UNKNOWN",
			"license": "MIT License",
			"licenseCompat": true,
			"errorCode": 0
		},
		{
			"name": "requirements-parser",
			"version": "0.5.0",
			"namever": "requirements-parser-0.5.0",
			"size": 11523,
			"homePage": "https://github.com/madpah/requirements-parser",
			"author": "Paul Horton",
			"license": "Apache Software License",
			"licenseCompat": true,
			"errorCode": 0
		},
		{
			"name": "fhconfparser",
			"version": "2022",
			"namever": "fhconfparser-2022",
			"size": 14586,
			"homePage": "https://github.com/FHPythonUtils/FHConfParser",
			"author": "FredHappyface",
			"license": "MIT License",
			"licenseCompat": true,
			"errorCode": 0
		}
	]
}Poetry with dev requirementsAdd-u poetry:devto command-line to include dev packages (excluded by default)>> licensecheck -u poetry:dev

                                  list of packages
┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Compatible ┃ Package             ┃ License(s)                                    ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ ✔          │ astroid             │ GNU Lesser General Public License v2 (LGPLv2) │
│ ✔          │ rich                │ MIT License                                   │
│ ✔          │ types-setuptools    │ Apache Software License                       │
│ ✔          │ fhconfparser        │ MIT License                                   │
│ ✔          │ typed-ast           │ Apache License 2.0                            │
│ ✔          │ py                  │ MIT License                                   │
│ ✔          │ mccabe              │ MIT License                                   │
│ ✔          │ tomlkit             │ MIT License                                   │
│ ✔          │ coverage            │ Apache Software License                       │
│ ✔          │ Pygments            │ BSD License                                   │
│ ✔          │ requests            │ Apache Software License                       │
│ ✔          │ requirements-parser │ Apache Software License                       │
│ ✔          │ tomli               │ MIT License                                   │
│ ✔          │ pluggy              │ MIT License                                   │
│ ✔          │ isort               │ MIT License                                   │
│ ✔          │ urllib3             │ MIT License                                   │
│ ✖          │ pylint              │ GNU General Public License v2 (GPLv2)         │
│ ✔          │ iniconfig           │ MIT License                                   │
│ ✔          │ wrapt               │ BSD License                                   │
│ ✔          │ pytest              │ MIT License                                   │
│ ✔          │ pip                 │ MIT License                                   │
│ ✔          │ charset-normalizer  │ MIT License                                   │
│ ✔          │ packaging           │ Apache Software License, BSD License          │
│ ✔          │ commonmark          │ BSD License                                   │
│ ✔          │ lazy-object-proxy   │ BSD License                                   │
│ ✔          │ platformdirs        │ MIT License                                   │
│ ✔          │ certifi             │ Mozilla Public License 2.0 (MPL 2.0)          │
│ ✔          │ colorama            │ BSD License                                   │
│ ✔          │ attrs               │ MIT License                                   │
│ ✔          │ dill                │ BSD License                                   │
│ ✔          │ idna                │ BSD License                                   │
│ ✔          │ importlib-resources │ Apache Software License                       │
│ ✔          │ handsdown           │ MIT License                                   │
│ ✔          │ pyparsing           │ MIT License                                   │
└────────────┴─────────────────────┴───────────────────────────────────────────────┘PEP 631 (with or without optional dependencies)PEP 631 mode enables support for reading dependency information frompyproject.tomlin the format specified by PEP 631.
This format is used by build systems such as hatch.You can enable this mode by using-u PEP631, and include the optional dependencies of extras by using-u PEP631:tests;dev;docs,
but it's recommended to use this instead:[tool.licensecheck]using="PEP631"# OR[tool.licensecheck]using="PEP631:tests;dev;docs"By default no optional dependencies are included.Helpusage: __main__.py [-h] [--format FORMAT] [--file FILE] [--using USING]
                   [--ignore-packages IGNORE_PACKAGES [IGNORE_PACKAGES ...]]
                   [--fail-packages FAIL_PACKAGES [FAIL_PACKAGES ...]]
                   [--ignore-licenses IGNORE_LICENSES [IGNORE_LICENSES ...]]
                   [--fail-licenses FAIL_LICENSES [FAIL_LICENSES ...]] [--zero]

Output the licenses used by dependencies and check if these are compatible with the project license.

options:
  -h, --help            show this help message and exit
  --format FORMAT, -f FORMAT
                        Output format. one of: json, markdown, csv, ansi, simple. default=simple
  --file FILE, -o FILE  Filename to write to (omit for stdout)
  --using USING, -u USING
                        Environment to use e.g. requirements.txt. one of: requirements, poetry, PEP631. default=poetry
  --ignore-packages IGNORE_PACKAGES [IGNORE_PACKAGES ...]
                        a list of packages to ignore (compat=True)
  --fail-packages FAIL_PACKAGES [FAIL_PACKAGES ...]
                        a list of packages to fail (compat=False)
  --ignore-licenses IGNORE_LICENSES [IGNORE_LICENSES ...]
                        a list of licenses to ignore (skipped, compat may still be False)
  --fail-licenses FAIL_LICENSES [FAIL_LICENSES ...]
                        a list of licenses to fail (compat=False)
  --skip-dependencies SKIP_DEPENDENCIES [SKIP_DEPENDENCIES ...]
						a list of dependencies to skip (compat=False)
  --zero, -0            Return non zero exit code if an incompatible license is foundYou can also import this into your own project and use any of the functions
in the DOCSConfiguration ExampleConfiguration files are parsed in the following order:pyproject.toml,setup.cfg,licensecheck.toml,licensecheck.json,licensecheck.ini,~/licensecheck.toml,~/licensecheck.json,~/licensecheck.ini⚠ All config files are parsed, however configuration defined in previous files takes precedentAdd optional path to requirements.txt as outlined inhttps://github.com/FHPythonUtils/LicenseCheck/issues/9#issuecomment-898878228for example:licensecheck --using requirements:c:/path/to/reqs.txt;path/to/other/reqs.txtExample 1: pyproject.tomlThe following config is equivalent tolicensecheck -u 'requirements:requirements.txt;requirements_optional.txt' -f json[tool.licensecheck]using="requirements:requirements.txt;requirements_optional.txt"format="json"Example 2: licensecheck.jsonThe following config is equivalent tolicensecheck -u 'requirements:requirements.txt;requirements_optional.txt' -f json{"tool":{"licensecheck":{"using":"requirements:requirements.txt;requirements_optional.txt","format":"json"}}}Example 3: licensecheck.iniThe following config is equivalent tolicensecheck -u 'requirements:requirements.txt;requirements_optional.txt' -f json[licensecheck]using="requirements:requirements.txt;requirements_optional.txt"format="json"DocumentationA high-level overview of how the documentation is organized organized will help you know
where to look for certain things:TheTechnical Referencedocuments APIs and other aspects of the
machinery. This documentation describes how to use the classes and functions at a lower level
and assume that you have a good high-level understanding of the software.Install With PIPpipinstalllicensecheckHead tohttps://pypi.org/project/licensecheck/for more infoLanguage informationBuilt forThis program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and
3.11Install Python on WindowsChocolateychocoinstallpythonWindows - Python.orgTo install Python, go tohttps://www.python.org/downloads/windows/and download the latest
version.Install Python on LinuxAptsudoaptinstallpython3.xDnfsudodnfinstallpython3.xInstall Python on MacOSHomebrewbrewinstallpython@3.xMacOS - Python.orgTo install Python, go tohttps://www.python.org/downloads/macos/and download the latest
version.How to runWindowsModulepy -3.x -m [module]or[module](if module installs a script)Filepy -3.x [file]or./[file]Linux/ MacOSModulepython3.x -m [module]or[module](if module installs a script)Filepython3.x [file]or./[file]BuildingThis project useshttps://github.com/FHPythonUtils/FHMaketo automate most of the building. This
command generates the documentation, updates the requirements.txt and builds the library artefactsNote the functionality provided by fhmake can be approximated by the followinghandsdown--cleanup-odocumentation/reference
poetryexport-frequirements.txt--outputrequirements.txt
poetryexport-frequirements.txt--withdev--outputrequirements_optional.txt
poetrybuildfhmake auditcan be run to perform additional checksTestingFor testing with the version of python used by poetry usepoetryrunpytestAlternatively usetoxto run tests over python 3.8 - 3.11toxDownload ProjectCloneUsing The Command LinePress the Clone or download button in the top rightCopy the URL (link)Open the command line and change directory to where you wish to
clone toType 'git clone' followed by URL in step 2gitclonehttps://github.com/FHPythonUtils/LicenseCheckMore information can be found athttps://help.github.com/en/articles/cloning-a-repositoryUsing GitHub DesktopPress the Clone or download button in the top rightClick open in desktopChoose the path for where you want and click CloneMore information can be found athttps://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktopDownload Zip FileDownload this GitHub repositoryExtract the zip archiveCopy/ move to the desired locationCommunity FilesLicenceMIT License
Copyright (c) FredHappyface
(See theLICENSEfor more information.)ChangelogSee theChangelogfor more information.Code of ConductOnline communities include people from many backgrounds. TheProjectcontributors are committed to providing a friendly, safe and welcoming
environment for all. Please see theCode of Conductfor more information.ContributingContributions are welcome, please see theContributing Guidelinesfor more information.SecurityThank you for improving the security of the project, please see theSecurity Policyfor more information.SupportThank you for using this project, I hope it is of use to you. Please be aware that
those involved with the project often do so for fun along with other commitments
(such as work, family, etc). Please see theSupport Policyfor more information.RationaleThe rationale acts as a guide to various processes regarding projects such as
the versioning scheme and the programming styles used. Please see theRationalefor more information.