aboutcode-toolkit
  • AboutCode Toolkit
    • Introduction
    • Build and tests status
    • REQUIREMENTS
    • INSTALLATION
    • ACTIVATE the VIRTUALENV
    • DEACTIVATE the VIRTUALENV
    • VERSIONING SCHEMA
    • REFERENCE
    • TESTS and DEVELOPMENT
    • CLEAN BUILD AND INSTALLED FILES
    • HELP and SUPPORT
    • SOURCE CODE
    • HACKING
    • LICENSE
  • General
    • AboutCode Toolkit Defined
    • Key Terminology
    • Using gen to Generate ABOUT file(s)
      • Prepare Your Software Inventory for gen Standard Field Names
      • Fields Renaming and Optional Custom Fields
      • Run gen to Generate ABOUT file(s)
    • Using attrib to Generate a Product Attribution Notice Package
      • Prepare an Attribution Template to Use
        • Use jinja2 Features to Customize Your Attribution Template
      • Run attrib to Generate a Product Attribution Notice Package
    • Using inventory to Generate a Software Inventory
      • Generate a Software Inventory of Your Codebase from ABOUT file(s)
  • Specification
    • Purpose
    • Getting Started
    • Specification
      • ABOUT file name
      • Lines of text
      • Field name
      • Field value
      • Fields are mandatory, optional or custom extension
      • Fields validation
      • Fields order and multiple occurrences
      • Field referencing a file
      • Field referencing a URL
      • Flag fields
      • Referencing the file or directory documented by an ABOUT file
      • Mandatory fields
      • Optional Information fields
      • Optional Owner and Author fields
      • Optional Licensing fields
        • Notes
      • Optional Boolean flag fields
      • Optional Boolean and Character fields
      • Optional Extension fields
      • Optional Extension fields to reference files stored in a version control system (VCS)
      • Optional Extension fields for checksums
      • Fields Type
      • Type description
  • Reference
    • about
      • Syntax
      • Options
      • Commands
    • attrib
      • Syntax
      • Options
      • Purpose
        • Details
    • check
      • Syntax
      • Options
      • Purpose
        • Details
      • Special Notes
        • --djc
        • --exclude
    • collect_redist_src
      • Syntax
      • Options
      • Purpose
        • Details
    • gen
      • Syntax
      • Options
      • Purpose
        • Details
      • Special Notes
    • gen_license
      • Syntax
      • Options
      • Purpose
        • Details
      • Special Notes
    • inventory
      • Syntax
      • Options
      • Purpose
        • Details
      • Special Notes
        • Multiple licenses support format
        • Multiple license_file support
        • --exclude
    • transform
      • Syntax
      • Options
      • Purpose
        • Details
      • --help-format
      • Example
        • fields renaming
          • conf.txt
          • input.csv
          • Command
          • output.csv
      • Special Notes
    • Notes
      • Configure proxy
  • Type of Errors
    • NOTSET
      • Trigger:
        • Details
    • DEBUG
      • Trigger:
        • Details
    • INFO
      • Trigger:
    • WARNING
      • Trigger:
    • ERROR
      • Trigger:
    • CRITICAL
      • Trigger:
aboutcode-toolkit
  • AboutCode Toolkit's Documentation
  • Edit on GitHub
Next

AboutCode Toolkit's Documentation

Welcome to the AboutCode Toolkit's Documentation.

  • AboutCode Toolkit
    • Introduction
    • Build and tests status
    • REQUIREMENTS
    • INSTALLATION
    • ACTIVATE the VIRTUALENV
    • DEACTIVATE the VIRTUALENV
    • VERSIONING SCHEMA
    • REFERENCE
    • TESTS and DEVELOPMENT
    • CLEAN BUILD AND INSTALLED FILES
    • HELP and SUPPORT
    • SOURCE CODE
    • HACKING
    • LICENSE
  • General
    • AboutCode Toolkit Defined
    • Key Terminology
    • Using gen to Generate ABOUT file(s)
    • Using attrib to Generate a Product Attribution Notice Package
    • Using inventory to Generate a Software Inventory
  • Specification
    • Purpose
    • Getting Started
    • Specification
  • Reference
    • about
    • attrib
    • check
    • collect_redist_src
    • gen
    • gen_license
    • inventory
    • transform
    • Notes
  • Type of Errors
    • NOTSET
    • DEBUG
    • INFO
    • WARNING
    • ERROR
    • CRITICAL
Next

© Copyright nexb Inc..

Built with Sphinx using a theme provided by Read the Docs.