csspin-ce 4.0.1

Plugin-package for providing CONTACT Elements-specific plugins for the csspin task runner.

csspin-ce is maintained and published by CONTACT Software GmbH and serves plugins for building and developing CONTACT Elements-based applications using the csspin task runner.

The following plugins are available:

• csspin_ce.ce_services: Plugin for provisioning and running services required by CONTACT Elements applications.

• csspin_ce.ce_support_tools: Plugin for supporting tools used in CONTACT Elements applications.

• csspin_ce.contact_elements: Plugin for configuring the umbrella release of CONTACT Elements, which changes the behavior of the other plugins of this package.

• csspin_ce.localization: Plugin for localization of CONTACT Elements applications.

• csspin_ce.mkinstance: Plugin for creating and managing instances of CONTACT Elements applications.

• csspin_ce.pkgtest: Plugin for testing Python wheels containing CONTACT Elements components.

Prerequisites

csspin is available on PyPI and can be installed using pip, pipx, or any other Python package manager, e.g.:

python -m pip install csspin

Using csspin-ce

The csspin-ce package and its plugins can be installed by defining those within the spinfile.yaml configuration file of your project.

spin:
  project_name: my_project

# To develop plugins comfortably, install the packages editable as
# follows and add the relevant plugins to the list 'plugins' below
plugin_packages:
  - csspin-ce

# The list of plugins to be used for this project.
plugins:
  - csspin_ce.mkinstance

python:
  version: 3.9.8

Note

Assuming that my_project is a component based on CONTACT Elements CE16+.

If the spinfile.yaml is configured correctly, you can provision the project using spin provision, that will automatically create a Python virtual environment and install the required dependencies. After that, you can create a CONTACT Elements instance using spin mkinstance and do other great things.