Skip to content

config-reference.rst

Latest commit

 

History

History
120 lines (82 loc) · 4.22 KB

config-reference.rst

File metadata and controls

120 lines (82 loc) · 4.22 KB
Raw

Configuration Reference

.. currentmodule:: fromager.packagesettings

Per-package Settings

Settings for individual packages can be placed in the overrides/settings/ directory. Files should be named using the canonicalized name of the package. For example flash_attn.yaml.

.. autopydantic_model:: fromager.packagesettings.PackageSettings


.. autopydantic_model:: fromager.packagesettings.BuildOptions


.. autopydantic_model:: fromager.packagesettings.DownloadSource


.. autopydantic_model:: fromager.packagesettings.GitOptions


.. autopydantic_model:: fromager.packagesettings.ResolverDist


.. autopydantic_model:: fromager.packagesettings.ProjectOverride


.. autopydantic_model:: fromager.packagesettings.PurlConfig


.. autopydantic_model:: fromager.packagesettings.SbomSettings

SBOM upstream purls

When purl.upstream is absent, the upstream SBOM entry identifies the resolved source as pkg:pypi/<package name>@<resolved version>. The per-package purl.name, purl.type, and purl.namespace settings and the global sbom.purl_type setting affect the wheel entry only. Previously, those settings also changed the upstream entry. Set purl.upstream to the full source purl when the source is not the resolved PyPI package.

Source Resolver

.. autopydantic_model:: PyPISDistResolver
   :inherited-members: AbstractPyPIResolver, CooldownMixin
   :members: download_kinds, supports_override_hooks, resolves_prebuilt_wheel


.. autopydantic_model:: PyPIPrebuiltResolver
   :inherited-members: AbstractPyPIResolver, CooldownMixin
   :members: download_kinds, supports_override_hooks, resolves_prebuilt_wheel


.. autopydantic_model:: PyPIDownloadResolver
   :inherited-members: AbstractPyPIResolver, CooldownMixin
   :members: download_kinds, supports_override_hooks, resolves_prebuilt_wheel


.. autopydantic_model:: PyPIGitResolver
   :inherited-members: AbstractPyPIResolver, CooldownMixin
   :members: download_kinds, supports_override_hooks, resolves_prebuilt_wheel


.. autopydantic_model:: GitHubTagDownloadResolver
   :inherited-members: AbstractGitSourceResolver, CooldownMixin
   :members: download_kinds, supports_override_hooks, resolves_prebuilt_wheel


.. autopydantic_model:: GitHubTagCloneResolver
   :inherited-members: AbstractGitSourceResolver, CooldownMixin
   :members: download_kinds, supports_override_hooks, resolves_prebuilt_wheel


.. autopydantic_model:: GitLabTagDownloadResolver
   :inherited-members: AbstractGitSourceResolver, CooldownMixin
   :members: download_kinds, supports_override_hooks, resolves_prebuilt_wheel


.. autopydantic_model:: GitLabTagCloneResolver
   :inherited-members: AbstractGitSourceResolver, CooldownMixin
   :members: download_kinds, supports_override_hooks, resolves_prebuilt_wheel


.. autopydantic_model:: NotAvailableResolver
   :members: download_kinds, supports_override_hooks, resolves_prebuilt_wheel


.. autopydantic_model:: HookSDistResolver
   :inherited-members: AbstractHookResolver, CooldownMixin
   :members: download_kinds, supports_override_hooks, resolves_prebuilt_wheel


.. autopydantic_model:: HookPrebuiltResolver
   :inherited-members: AbstractHookResolver, CooldownMixin
   :members: download_kinds, supports_override_hooks, resolves_prebuilt_wheel


.. autoclass:: BuildSDist

   .. autoattribute:: pep517
   .. autoattribute:: tarball


.. autoclass:: DownloadedSource
   :members: path, kind


.. autoclass:: DownloadKind

   .. autoattribute:: sdist
   .. autoattribute:: tarball
   .. autoattribute:: prebuilt_wheel
   .. autoattribute:: git_checkout
   .. autoattribute:: any_source
   .. autoattribute:: not_available


.. versionchanged:: 0.103.0

   Configured hook downloads require a concrete result kind supported by the
   selected profile. ``any_source`` and ``not_available`` are not accepted as
   result kinds. See :ref:`download_source_hook` for legacy path defaults and
   the typed hook contract.

Global Settings

The global changelogs can be placed in overrides/settings.yaml.

If you prefer managing a single settings file, per-package settings can also be kept in this file.

.. autopydantic_model:: fromager.packagesettings.SettingsFile


.. autopydantic_model:: fromager.packagesettings.WheelSettings