Open Source Software Attribution Generator

A Python tool to generate attribution files for open source software dependencies, with enhanced support for license expressions, "others" URLs, global project configuration, and component modification details.

This project was built using Cursor, the world's best IDE for AI-powered development.

Features

• Generates comprehensive attribution files for open source components
• Supports multiple input formats (Excel, JSON, YAML)
• Handles complex license expressions (AND, OR combinations)
• Supports "others" URLs for additional notices
• Tracks component modifications
• Configurable project settings
• Customizable templates

Requirements

• Python 3.8+
• uv (Python package installer)

Installation

1. Clone the repository:

git clone <repository-url>
cd Attribution_Generator

2. Install dependencies using uv:

uv pip install -e .

Usage

1. Configure your project settings in main.py:

PROJECT_NAME = "Your Project Name"
COPYRIGHT_HOLDER_FULL = "Your Full Company Name L.L.C."
COPYRIGHT_HOLDER_SHORT = "YourCo"

2. Prepare your components file:

   • Use components.xlsx for Excel input
   • Required columns: name, copyright, license
   • Optional columns: version, others_url, modified, modified_url

3. Run the generator:

python main.py

The tool will generate an ATTRIBUTIONS.txt file with properly formatted attributions for all components.

Input File Format

Excel Format

Required columns:

• name: Component name
• copyright: Copyright notice
• license: License expression

Optional columns:

• version: Component version
• others_url: URL for additional notices
• modified: Whether the component is modified (true/false)
• modified_url: URL to modified code

JSON/YAML Format

{
  "components": [
    {
      "name": "Component Name",
      "copyright": "Copyright Notice",
      "license": "License Expression",
      "version": "1.0.0",
      "others_url": "https://example.com/notice",
      "modified": false,
      "modified_url": null
    }
  ]
}

Configuration Files

licenses.yaml

Contains license texts and definitions. Example:

MIT: |
  MIT License
  Copyright (c) [year] [fullname]
  ...

OTHERS_DEFINITION: |
  [Default text for components with "others" license]

templates.yaml

Contains templates for different sections of the attribution file. Example:

header: |
  Open Source Software Attribution
  Project: {project_name}
  Copyright (c) {copyright_holder_full}
  ...

component_listing: |
  {serial_number}. {name} (v{version})
  {copyright}{modification_notice}

Development

This project uses pyproject.toml for dependency management and uv as the package installer. The main dependencies are:

• pandas (>=1.5.0)
• PyYAML (>=6.0)
• openpyxl (>=3.0.0)

Code Quality

The project maintains high code quality standards through:

• Automated Pylint checks on every push
• Testing against Python 3.8, 3.9, and 3.10
• Comprehensive docstrings and type hints
• PEP 8 style compliance

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.