installation.rst

Installation and setup

Configuration

For leveraging plugins from within the csspin-python plugin-package for csspin, csspin-python must be added to the list of plugin-packages within a project's spinfile.yaml.

plugin_packages:
    - csspin-python
plugins:
    - csspin_python:
        - python
        - pytest
python:
    version: "3.11.9"

After the configuration is done, the plugin-package can be provisioned by executing the following command within the project's directory:

spin provision

The plugins defined in the plugins section of the spinfile.yaml can now be used:

spin pytest --help

System requirements

The csspin-python plugin-package requires the following software to be installed on the host system in order to work properly for all provided plugins (if not further specified, the requirements apply to all operating systems):

• `csspin`_
• git (for fetching package sources from Git repositories)

On Linux systems, the following additional requirements must be met:

• Python build dependencies (see https://devguide.python.org/getting-started/setup-building/#build-dependencies)