Skip to main content

AboutCode-toolkit is a tool to document the provenance (origin and license) of third-party software using small text files. Collect inventories and generate attribution documentation.

Project description

Introduction

The 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.2 at: https://aboutcode-toolkit.readthedocs.io/en/latest/specification.html

Build and tests status

Branch

Linux/macOS

Windows

Master

Linux Master branch tests status

Windows Master branch tests status

Develop

Linux Develop branch tests status

Windows Develop branch tests status

REQUIREMENTS

The 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 –version

Note

Debian 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-distutils

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

INSTALLATION

Checkout 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):

./configure

or on windows:

configure

ACTIVATE the VIRTUALENV

To activate the virtualenv, run (on posix):

source venv/bin/activate

or on windows:

venv\bin\activate

DEACTIVATE the VIRTUALENV

To deactivate the virtualenv, run (on both posix and windows):

deactivate

VERSIONING SCHEMA

Starting at AboutCode version 4.0.0, the AboutCode Toolkit will follow SemVer for the versioning schema.

i.e. MAJOR.MINOR.PATCH format
  1. MAJOR version when making incompatible API changes,

  2. MINOR version when making functionality in a backwards compatible manner, and

  3. PATCH version when making backwards compatible bug fixes.

REFERENCE

See https://aboutcode-toolkit.readthedocs.io/en/latest/ for documentation.

See https://aboutcode-toolkit.readthedocs.io/en/latest/reference.html for reference.

TESTS and DEVELOPMENT

To install all the needed development dependencies, run (on posix):

./configure –dev

or on windows:

configure –dev

To verify that everything works fine you can run the test suite with:

pytest

CLEAN BUILD AND INSTALLED FILES

To clean the built and installed files, run (on posix):

./configure –clean

or on windows:

configure –clean

HELP and SUPPORT

If you have a question or find a bug, enter a ticket at:

https://github.com/nexB/aboutcode-toolkit

For issues, you can use:

https://github.com/nexB/aboutcode-toolkit/issues

SOURCE CODE

The AboutCode Toolkit is available through GitHub. For the latest version visit:

https://github.com/nexB/aboutcode-toolkit

HACKING

We accept pull requests provided under the same license as this tool. You agree to the http://developercertificate.org/

LICENSE

The AboutCode Toolkit is released under the Apache 2.0 license. See (of course) the about.ABOUT file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aboutcode_toolkit-11.0.0.tar.gz (400.3 kB view details)

Uploaded Source

Built Distribution

aboutcode_toolkit-11.0.0-py3-none-any.whl (69.6 kB view details)

Uploaded Python 3

File details

Details for the file aboutcode_toolkit-11.0.0.tar.gz.

File metadata

  • Download URL: aboutcode_toolkit-11.0.0.tar.gz
  • Upload date:
  • Size: 400.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for aboutcode_toolkit-11.0.0.tar.gz
Algorithm Hash digest
SHA256 561f1bfe51a81f13c8865600ca44921a2db29d337bacaad69056d3539042c4de
MD5 747228e683496c73acfc1e64c3ef4c80
BLAKE2b-256 d92d8ce6fc6bd4b44e877e01f55cade9a0a8b2c2183c9426fe4f0bd8a95b2dff

See more details on using hashes here.

File details

Details for the file aboutcode_toolkit-11.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aboutcode_toolkit-11.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 35374417095a2d8d4c3fa78d1c673850e6fd559d0dcd9b06dd4a49520d9f5573
MD5 6109bd4bba3847f37ad4d4b082f0ea85
BLAKE2b-256 2a00c5603b3d776b5614b422d762de76b20b678a18c179a63668f56b8b924ce3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page