`python/all`¶

Configure an end-to-end Python workflow for this project.

Description¶

This component automatically configures a workflow to

scan the project for security, and code-quality issues
build a source distribution
build a binary distribution (pure-Python projects only)
test the project
publish the distributions to PyPI

Usage¶

include:
  - component: git.ligo.org/computing/gitlab/components/python/all@<VERSION>

Inputs¶

Input	Default value	Description
`project_dir`	`"."`	Python project path (containing the `pyproject.toml` file)
`python`	`"python"`	Name of the Python interpreter to call
`python_versions`	`["3.8", "3.9", "3.10", "3.11", "3.12"]`	The list of Python versions to build when building with `pure_python: false`
`code_quality_analzer`	`"flake8"`	Code quality analyzer to configure
`code_quality_options`	`""`	Options to pass to the code quality analyzer
`run_advanced_sast`	`false`	Use GitLab Advanced SAST
`sdist`	`true`	Build a source distribution (tarball)
`wheel`	`true`	Build a binary distribution (wheel)
`install_extra`	None	Name(s) of the extra feature group(s) to install (comma-separated) when testing
`extra_test_commands`	`[]`	Extra test commands to run during the test job(s) (after running pytest)
`publish`	`true`	Publish distributions to pypi.org for git tags

Notes¶

Wheels for compiled projects¶

The python/all meta-component isn't flexible enough to configure building wheels for Python projects that compile extension modules.

See the dedicated python/wheel component for instructions on configuring a pipeline to build wheels for compiled projects.

Customisation¶

Almost all of the scanning, build, test, and publish behaviour can be configured via the pyproject.toml project configuration file.

See the Customisation sections for the relevant sub-components for any other relevant details.

Examples¶

Build and test a Python application

To configure a pipeline that builds for the latest versions of Python, and installs the [test] optional-dependencies group for testing:

include:
  - component: git.ligo.org/computing/gitlab/components/python/all@<VERSION>
    inputs:
      code_quality_analzer: "ruff"
      install_extra: "test"
      python_versions:
        - 3.10
        - 3.11
        - 3.12

python/all¶