Package: aboutcode-toolkit
IntroductionThe AboutCode Toolkit and ABOUT files provide a simple way to document the
origin, license, usage and other important or interesting information about
third-party software components that you use in your project.You start by storing ABOUT files (a small YAML formatted text file with field/value pairs)
side-by-side with each of the third-party software components you use.
Each ABOUT file documents origin and license for one software.
There are many examples of ABOUT files (valid or invalid) in the testdata/
directory of the whole repository.The current version of the AboutCode Toolkit can read these ABOUT files so that you
can collect and validate the inventory of third-party components that you use.In addition, this tool is able to generate attribution notices and
identify redistributable source code used in your project to help you comply
with open source licenses conditions.This version of the AboutCode Toolkit follows the ABOUT specification version 3.3.1 at:https://aboutcode-toolkit.readthedocs.io/en/latest/specification.htmlBuild and tests statusBranchLinux/macOSWindowsMasterDevelopREQUIREMENTSThe AboutCode Toolkit is tested with Python 3.7 or above only on Linux, Mac and Windows.
You will need to install a Python interpreter if you do not have one already
installed.On Linux and Mac, Python is typically pre-installed. To verify which
version may be pre-installed, open a terminal and type:python –versionNoteDebian has decided that distutils is not a core python package, so it is not included in the last versions of debian and debian-based OSes.
A solution is to run:sudo apt install python3-distutilsOn Windows or Mac, you can download the latest Python here:https://www.python.org/downloads/Download the .msi installer for Windows or the .dmg archive for Mac.
Open and run the installer using all the default options.INSTALLATIONCheckout or download and extract the AboutCode Toolkit from:https://github.com/nexB/aboutcode-toolkit/To install all the needed dependencies in a virtualenv, run (on posix):./configureor on windows:configureACTIVATE the VIRTUALENVTo activate the virtualenv, run (on posix):source venv/bin/activateor on windows:venv\bin\activateDEACTIVATE the VIRTUALENVTo deactivate the virtualenv, run (on both posix and windows):deactivateVERSIONING SCHEMAStarting at AboutCode version 4.0.0, the AboutCode Toolkit will follow SemVer for the versioning schema.i.e. MAJOR.MINOR.PATCH formatMAJOR version when making incompatible API changes,MINOR version when making functionality in a backwards compatible manner, andPATCH version when making backwards compatible bug fixes.REFERENCESeehttps://aboutcode-toolkit.readthedocs.io/en/latest/for documentation.Seehttps://aboutcode-toolkit.readthedocs.io/en/latest/reference.htmlfor reference.TESTS and DEVELOPMENTTo install all the needed development dependencies, run (on posix):./configure –devor on windows:configure –devTo verify that everything works fine you can run the test suite with:pytestCLEAN BUILD AND INSTALLED FILESTo clean the built and installed files, run (on posix):./configure –cleanor on windows:configure –cleanHELP and SUPPORTIf you have a question or find a bug, enter a ticket at:https://github.com/nexB/aboutcode-toolkitFor issues, you can use:https://github.com/nexB/aboutcode-toolkit/issuesSOURCE CODEThe AboutCode Toolkit is available through GitHub. For the latest version visit:https://github.com/nexB/aboutcode-toolkitHACKINGWe accept pull requests provided under the same license as this tool.
You agree to thehttp://developercertificate.org/LICENSEThe AboutCode Toolkit is released under the Apache 2.0 license.
See (of course) the about.ABOUT file for details.