Skip to content

Document what flit_core includes in a sdist #540

@pfmoore

Description

@pfmoore

In the docs it notes that building via a frontend other than flit includes a "minimal" set of files needed to build the sdist. Please could the docs be amended to include the exact settings for [tool.flit.sdist] to replicate flit_core's behaviour?

Having the docs specify settings needed to get the default flit_core behaviour everywhere would make it easier to set up a consistent sdist build workflow that didn't rely on which build frontend was used.

The alternative is to review and explicitly choose exactly what files to include. This is feasible, but risks omitting something important either by accident or from ignorance. Having "what flit considers the minimal requirement" documented reduces that risk. (To be fair, the minimum is probably just "pyproject.toml and the project source directory" but explicit is better than implicit, as they say 😉)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions