Metadata-Version: 2.4
Name: csspin-ce
Version: 4.0.2
Summary: Plugin-package for providing CONTACT Elements-specific plugins for the csspin task runner.
Author-email: CONTACT Software GmbH <info@contact-software.com>
Maintainer-email: Waleri Enns <waleri.enns@contact-software.com>, Benjamin Thomas Schwertfeger <benjaminthomas.schwertfeger@contact-software.com>, Fabian Hafer <fabian.hafer@contact-software.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://contact-software.com
Classifier: Environment :: Console
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: cryptography
Requires-Dist: csspin-frontend
Requires-Dist: csspin-java
Requires-Dist: csspin-python
Dynamic: license-file

|Latest Version| |Python| |License|

`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.:

.. code-block:: console

   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.

.. code-block:: yaml

    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.

.. _`CONTACT Software GmbH`: https://contact-software.com
.. |Python| image:: https://img.shields.io/pypi/pyversions/csspin-ce.svg?style=flat
    :target: https://pypi.python.org/pypi/csspin-ce/
    :alt: Supported Python Versions
.. |Latest Version| image:: http://img.shields.io/pypi/v/csspin-ce.svg?style=flat
    :target: https://pypi.python.org/pypi/csspin-ce/
    :alt: Latest Package Version
.. |License| image:: http://img.shields.io/pypi/l/csspin-ce.svg?style=flat
    :target: https://www.apache.org/licenses/LICENSE-2.0.txt
    :alt: License
.. _`csspin`: https://pypi.org/project/csspin
