Skip to content

Add LICENSE to source distribution #462

Description

@moritzsommer

Current Situation

In the current setup, the LICENSE file is not added to the source distribution of this SDK.

Executing the job from the CI locally results in a /dist folder containing no LICENSE. I tested this with both CMD and WSL:

jobs:
sdk-publish:
# This job publishes the SDK package to PyPI
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./sdk
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.10
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build
- name: Create source and wheel dist
# (2024-12-11, s-heppner)
# The PyPI Action expects the dist files in a toplevel `/dist` directory,
# so we have to specify this as output directory here.
run: |
python -m build --outdir ../dist

Proposed Change

Add a LICENSE to every subdirectory with a pyproject.toml that functions as its own package, i.e. compliance_tool and sdk. Alternatively, we could adapt the CI to copy the LICENSE into the subdirectory every time we publish a new release.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementEnhancement of an existing featuregeneralSomething to do with the BaSyx Python SDK repository in general

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions