aboutcode-toolkit

v11.0.0

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. For more information about how to use this package see README

Latest version published 4 months ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

72 / 100

security
Security review needed
popularity
Small
maintenance
Healthy
community
Active

Explore Similar Packages

toolbox
42

Popularity

Small

GitHub Stars: 93
Forks: 42
Contributors: 30

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package aboutcode-toolkit, we found that it has been starred 93 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Jul 16, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like aboutcode-toolkit is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 6
Open PR: 6
Last Release: 4 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of aboutcode-toolkit based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that aboutcode-toolkit demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

Readme: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 30
Funding: No

With more than 10 contributors for the aboutcode-toolkit repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.7

Age: 7 years
Latest Release: 4 months ago
Dependencies: 6 Direct / 15 Total
Versions: 30
Maintainers: 4
Wheels: OS Independent

Readme

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:

Build and tests status

Branch	Linux/macOS	Windows
Master
Develop

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:

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:

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

MAJOR version when making incompatible API changes,
MINOR version when making functionality in a backwards compatible manner, and
PATCH version when making backwards compatible bug fixes.

REFERENCE

See for documentation.

See 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:

For issues, you can use:

SOURCE CODE

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

HACKING

We accept pull requests provided under the same license as this tool. You agree to the

LICENSE

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

aboutcode-toolkit dependencies

attrs certifi click jinja2 openpyxl saneyaml

FAQs

What is aboutcode-toolkit?

AboutCode-toolkit is a tool to document the provenance (origin and license) of third-party software using small text fi... Visit Snyk Advisor to see a full health score report for aboutcode-toolkit, including popularity, security, maintenance & community analysis.

Is aboutcode-toolkit popular?

The python package aboutcode-toolkit receives a total of 2,950 weekly downloads. As such, aboutcode-toolkit popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is aboutcode-toolkit well maintained?

We found that aboutcode-toolkit demonstrated a healthy version release cadence and project activity. It has a community of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is aboutcode-toolkit safe to use?

While scanning the latest version of aboutcode-toolkit, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 3 November-2024, at 11:31 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP