=================
AboutCode Toolkit
=================
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 | |master-posix| | |master-win| |
+-------+-----------------+--------------+
|Develop| |devel-posix| | |devel-win| |
+-------+-----------------+--------------+
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.
.. |master-posix| image:: https://api.travis-ci.org/nexB/aboutcode-toolkit.png?branch=master
:target: https://travis-ci.org/nexB/aboutcode-toolkit
:alt: Linux Master branch tests status
.. |devel-posix| image:: https://api.travis-ci.org/nexB/aboutcode-toolkit.png?branch=develop
:target: https://travis-ci.org/nexB/aboutcode-toolkit
:alt: Linux Develop branch tests status
.. |master-win| image:: https://ci.appveyor.com/api/projects/status/uwj2gh8i9ga1mqwn/branch/master?png=true
:target: https://ci.appveyor.com/project/nexB/aboutcode-toolkit
:alt: Windows Master branch tests status
.. |devel-win| image:: https://ci.appveyor.com/api/projects/status/uwj2gh8i9ga1mqwn/branch/develop?png=true
:target: https://ci.appveyor.com/project/nexB/aboutcode-toolkit
:alt: Windows Develop branch tests status
Raw data
{
"_id": null,
"home_page": "https://github.com/nexB/aboutcode-toolkit",
"name": "aboutcode-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "license, about, metadata, package, copyright, attribution, software, inventory, open source, sca, SBOM, spdx",
"author": "nexB. Inc. and others",
"author_email": "info@aboutcode.org",
"download_url": "https://files.pythonhosted.org/packages/d9/2d/8ce6fc6bd4b44e877e01f55cade9a0a8b2c2183c9426fe4f0bd8a95b2dff/aboutcode_toolkit-11.0.0.tar.gz",
"platform": null,
"description": "=================\nAboutCode Toolkit\n=================\n\nIntroduction\n------------\nThe AboutCode Toolkit and ABOUT files provide a simple way to document the\norigin, license, usage and other important or interesting information about\nthird-party software components that you use in your project.\n\nYou start by storing ABOUT files (a small YAML formatted text file with field/value pairs)\nside-by-side with each of the third-party software components you use.\nEach ABOUT file documents origin and license for one software.\nThere are many examples of ABOUT files (valid or invalid) in the testdata/\ndirectory of the whole repository.\n\nThe current version of the AboutCode Toolkit can read these ABOUT files so that you\ncan collect and validate the inventory of third-party components that you use.\n\nIn addition, this tool is able to generate attribution notices and\nidentify redistributable source code used in your project to help you comply\nwith open source licenses conditions.\n\nThis version of the AboutCode Toolkit follows the ABOUT specification version 3.3.2 at:\nhttps://aboutcode-toolkit.readthedocs.io/en/latest/specification.html\n\n\nBuild and tests status\n----------------------\n\n+-------+-----------------+--------------+\n|Branch | **Linux/macOS** | **Windows** |\n+=======+=================+==============+\n|Master | |master-posix| | |master-win| |\n+-------+-----------------+--------------+\n|Develop| |devel-posix| | |devel-win| |\n+-------+-----------------+--------------+\n\n\nREQUIREMENTS\n------------\nThe AboutCode Toolkit is tested with Python 3.7 or above only on Linux, Mac and Windows.\nYou will need to install a Python interpreter if you do not have one already\ninstalled.\n\nOn Linux and Mac, Python is typically pre-installed. To verify which\nversion may be pre-installed, open a terminal and type:\n\n python --version\n\nNote\n~~~~\n 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.\n A solution is to run: `sudo apt install python3-distutils`\n\nOn Windows or Mac, you can download the latest Python here:\n https://www.python.org/downloads/\n\nDownload the .msi installer for Windows or the .dmg archive for Mac.\nOpen and run the installer using all the default options.\n\nINSTALLATION\n------------\nCheckout or download and extract the AboutCode Toolkit from:\n https://github.com/nexB/aboutcode-toolkit/\n\nTo install all the needed dependencies in a virtualenv, run (on posix):\n ./configure\nor on windows:\n configure\n\nACTIVATE the VIRTUALENV\n-----------------------\nTo activate the virtualenv, run (on posix):\n source venv/bin/activate\nor on windows:\n venv\\\\bin\\\\activate\n\n\nDEACTIVATE the VIRTUALENV\n-------------------------\nTo deactivate the virtualenv, run (on both posix and windows):\n deactivate\n\n\nVERSIONING SCHEMA\n-----------------\nStarting at AboutCode version 4.0.0, the AboutCode Toolkit will follow SemVer for the versioning schema.\n\ni.e. MAJOR.MINOR.PATCH format\n 1. MAJOR version when making incompatible API changes,\n 2. MINOR version when making functionality in a backwards compatible manner, and\n 3. PATCH version when making backwards compatible bug fixes.\n\n\nREFERENCE\n---------\nSee https://aboutcode-toolkit.readthedocs.io/en/latest/ for documentation.\n\nSee https://aboutcode-toolkit.readthedocs.io/en/latest/reference.html for reference.\n\nTESTS and DEVELOPMENT\n---------------------\nTo install all the needed development dependencies, run (on posix):\n ./configure --dev\nor on windows:\n configure --dev\n\nTo verify that everything works fine you can run the test suite with:\n pytest\n\n\nCLEAN BUILD AND INSTALLED FILES\n-------------------------------\nTo clean the built and installed files, run (on posix):\n ./configure --clean\nor on windows:\n configure --clean\n\n\nHELP and SUPPORT\n----------------\nIf you have a question or find a bug, enter a ticket at:\n\n https://github.com/nexB/aboutcode-toolkit\n\nFor issues, you can use:\n\n https://github.com/nexB/aboutcode-toolkit/issues\n\n\nSOURCE CODE\n-----------\nThe AboutCode Toolkit is available through GitHub. For the latest version visit:\n https://github.com/nexB/aboutcode-toolkit\n\n\nHACKING\n-------\nWe accept pull requests provided under the same license as this tool.\nYou agree to the http://developercertificate.org/\n\n\nLICENSE\n-------\nThe AboutCode Toolkit is released under the Apache 2.0 license.\nSee (of course) the about.ABOUT file for details.\n\n\n.. |master-posix| image:: https://api.travis-ci.org/nexB/aboutcode-toolkit.png?branch=master\n :target: https://travis-ci.org/nexB/aboutcode-toolkit\n :alt: Linux Master branch tests status\n.. |devel-posix| image:: https://api.travis-ci.org/nexB/aboutcode-toolkit.png?branch=develop\n :target: https://travis-ci.org/nexB/aboutcode-toolkit\n :alt: Linux Develop branch tests status\n\n.. |master-win| image:: https://ci.appveyor.com/api/projects/status/uwj2gh8i9ga1mqwn/branch/master?png=true\n :target: https://ci.appveyor.com/project/nexB/aboutcode-toolkit\n :alt: Windows Master branch tests status\n.. |devel-win| image:: https://ci.appveyor.com/api/projects/status/uwj2gh8i9ga1mqwn/branch/develop?png=true\n :target: https://ci.appveyor.com/project/nexB/aboutcode-toolkit\n :alt: Windows Develop branch tests status\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "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.",
"version": "11.0.0",
"project_urls": {
"Homepage": "https://github.com/nexB/aboutcode-toolkit"
},
"split_keywords": [
"license",
" about",
" metadata",
" package",
" copyright",
" attribution",
" software",
" inventory",
" open source",
" sca",
" sbom",
" spdx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a00c5603b3d776b5614b422d762de76b20b678a18c179a63668f56b8b924ce3",
"md5": "6109bd4bba3847f37ad4d4b082f0ea85",
"sha256": "35374417095a2d8d4c3fa78d1c673850e6fd559d0dcd9b06dd4a49520d9f5573"
},
"downloads": -1,
"filename": "aboutcode_toolkit-11.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6109bd4bba3847f37ad4d4b082f0ea85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 69580,
"upload_time": "2024-07-16T02:46:18",
"upload_time_iso_8601": "2024-07-16T02:46:18.741274Z",
"url": "https://files.pythonhosted.org/packages/2a/00/c5603b3d776b5614b422d762de76b20b678a18c179a63668f56b8b924ce3/aboutcode_toolkit-11.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d92d8ce6fc6bd4b44e877e01f55cade9a0a8b2c2183c9426fe4f0bd8a95b2dff",
"md5": "747228e683496c73acfc1e64c3ef4c80",
"sha256": "561f1bfe51a81f13c8865600ca44921a2db29d337bacaad69056d3539042c4de"
},
"downloads": -1,
"filename": "aboutcode_toolkit-11.0.0.tar.gz",
"has_sig": false,
"md5_digest": "747228e683496c73acfc1e64c3ef4c80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 400324,
"upload_time": "2024-07-16T02:46:20",
"upload_time_iso_8601": "2024-07-16T02:46:20.775245Z",
"url": "https://files.pythonhosted.org/packages/d9/2d/8ce6fc6bd4b44e877e01f55cade9a0a8b2c2183c9426fe4f0bd8a95b2dff/aboutcode_toolkit-11.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-16 02:46:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nexB",
"github_project": "aboutcode-toolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"requirements": [],
"tox": true,
"lcname": "aboutcode-toolkit"
}
JSON
