csspin-python 2.0.0__py3-none-any.whl

csspin_python/python_schema.yaml

@@ -0,0 +1,131 @@
+# -*- mode: yaml; coding: utf-8 -*-
+#
+# Schema for the python plugin for spin
+
+python:
+    properties:
+        pyenv:
+            type: object
+            help: |
+                Configuration related to pyenv is used for provisioning the
+                Python interpreter
+            properties:
+                url:
+                    type: str
+                    help: URL to install pyenv from
+                path:
+                    type: path
+                    help: Path to cache the pyenv sources
+                cache:
+                    type: path
+                    help: Path to cache the Python sources downloaded by pyenv
+                python_build:
+                    type: path
+                    help: Path to the python-build builtin plugin of pyenv
+        user_pyenv:
+            type: bool
+            help: |
+                If ``False`` install pyenv from sources, otherwise use the pyenv
+                from PATH
+        nuget:
+            type: object
+            help: |
+                Configuration related to the Python provision on Windows using
+                nuget
+            properties:
+                url:
+                    type: str
+                    help: URL to install nuget from
+                exe:
+                    type: path
+                    help: Path to nuget executable
+                source:
+                    type: str
+                    help: Index to use for nuget sources
+        version:
+            type: str
+            help: |
+                The Python version to use for the whole project when using in
+                the context of spin
+        use:
+            type: str
+            help: |
+                The use property can be used to specify an alternative Python
+                source to use. This is useful to rather use the system Python
+                than the one defined in spinfile.yaml
+            default: ''
+        inst_dir:
+            type: path
+            help: Path to the installation directory of Python.
+        interpreter:
+            type: path
+            help: The path to the Python interpreter of the instance to use.
+        venv:
+            type: path
+            help: |
+                Path to the virtual environment which is used exclusively for
+                the project spin is running on
+        memo:
+            type: path
+            help: Path to the memoizer used to list installed packages
+        bindir:
+            type: path
+            help: |
+                Path of the virtual environment's binary directory on Linux;
+                equals "{python.venv}" on Windows
+        scriptdir:
+            type: path
+            help: |
+                Directory containing the executables of the Python virtual
+                environment
+        python:
+            type: path
+            help: |
+                The python property defines the path to the Python interpreter
+                to use.
+        pipconf:
+            type: str
+            help: |
+                Content of the pip.conf/pip.ini configuration file that will be
+                written into the environment.
+        # The provisioner type is evaluated during runtime and to complex to
+        # represent it in the schema.
+        # provisioner:
+        #   type:
+        #   help:
+        site_packages:
+            type: path internal
+            help: The path to the virtual environments site-packages directory.
+        devpackages:
+            type: list
+            help: A list of packages that will be editable installed
+        requirements:
+            type: list
+            help: |
+                The list of this project's external Python requirements, that
+                have to be installed into the project's virtual environment.
+                This excludes requirements stated as 'install_requires' in
+                setup.py/setup.cfg.
+        current_package:
+            type: object
+            help: Install configuration of the current python project
+            properties:
+                install:
+                    type: bool
+                    help: |
+                        Property to determine whether the current package should
+                        get installed or not.
+                extras:
+                    type: list
+                    help: The extras of the current package to install.
+        index_url:
+            type: str
+            help: |
+                The index url from where packages should get installed into the
+                venv. This value will also be put into cfg.python.pipconf, if
+                not already mentioned there.
+        build_wheels:
+            type: list
+            help: |
+                A list of packages that will be built along with the current
+                project when executing python:wheel.

csspin_python/radon.py

@@ -0,0 +1,59 @@
+# -*- mode: python; coding: utf-8 -*-
+#
+# Copyright (C) 2020 CONTACT Software GmbH
+# https://www.contact-software.com/
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Module implementing the radon plugin for spin"""
+
+import logging
+
+from csspin import config, info, option, sh, task
+
+defaults = config(
+    exe="radon",
+    opts=["-n", "{radon.mi_threshold}"],
+    mi_threshold="B",
+    requires=config(
+        spin=[
+            "csspin_python.python",
+        ],
+        python=["radon"],
+    ),
+)
+
+
+@task()
+def radon(
+    cfg,
+    allsource: option(
+        "--all",  # noqa: F821
+        "allsource",  # noqa: F821
+        is_flag=True,
+        help="Run for all src- and test-files.",  # noqa: F722,F821
+    ),
+    args,
+):
+    """Run radon to measure code complexity."""
+    if allsource:
+        files = ("{spin.project_root}/src", "{spin.project_root}/tests")
+    else:
+        files = args
+        if not files and hasattr(cfg, "vcs") and hasattr(cfg.vcs, "modified"):
+            info("Found modified files.")
+            files = cfg.vcs.modified
+        files = [f for f in files if f.endswith(".py")]
+    if files:
+        logging.debug(f"radon: Modified files: {files}")
+        sh("{radon.exe}", "mi", *cfg.radon.opts, *files)

csspin_python/radon_schema.yaml

@@ -0,0 +1,17 @@
+# -*- mode: yaml; coding: utf-8 -*-
+#
+# Schema for the radon plugin for spin
+
+radon:
+    type: object
+    help: Configuration of the radon plugin for spin
+    properties:
+        exe:
+            type: path
+            help: Path to the executable radon file.
+        mi_threshold:
+            type: str
+            help: |
+                The maintainability threshold can be either A, B or C, where A
+                is the best and C the worst. Radon will fail if any file's
+                maintainability score is below the defined threshold.

csspin_python-2.0.0.dist-info/METADATA

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: csspin_python
+Version: 2.0.0
+Summary: Plugin-package for csspin providing Python related plugins
+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: virtualenv
+Provides-Extra: aws-auth
+Requires-Dist: boto3; extra == "aws-auth"
+Requires-Dist: requests; extra == "aws-auth"
+Dynamic: license-file
+
+|Latest Version| |Python| |License|
+
+`csspin_python` is maintained and published by `CONTACT Software GmbH`_ and
+serves Python-based plugins for the `csspin`_ task runner.
+
+The following plugins are available:
+
+- `csspin_python.aws_auth`: A plugin for authenticating to CONTACT Elements
+  instances hosted on AWS.
+- `csspin_python.behave`: A plugin for running tests using Behave.
+- `csspin_python.debugpy`: A plugin for debugging Python code using `debugpy`_.
+- `csspin_python.devpi`: A plugin for simplified usage of `devpi`_.
+- `csspin_python.playwright`: A plugin for running tests using `playwright`_.
+- `csspin_python.pytest`: A plugin for running tests using pytest.
+- `csspin_python.python`: A plugin for provisioning Python environments  and
+  installing dependencies.
+- `csspin_python.radon`: A plugin for running `radon`_ to analyze code
+  complexity.
+- `csspin_python.sphinx`: A plugin for building Sphinx documentation.
+
+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_python
+-------------------
+
+The `csspin_python` 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_python
+
+    # The list of plugins to be used for this project.
+    plugins:
+      - csspin_python.pytest
+
+    python:
+      version: 3.9.8
+      requirements:
+        - sphinx-click
+        - sphinx-rtd-theme
+        - pytest-mock
+
+    pytest:
+      opts: [-m, "not slow"]
+      tests: [tests]
+
+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 run
+tests using ``spin pytest`` and do other great things.
+
+.. _`CONTACT Software GmbH`: https://contact-software.com
+.. |Python| image:: https://img.shields.io/pypi/pyversions/csspin_python.svg?style=flat
+    :target: https://pypi.python.org/pypi/csspin_python/
+    :alt: Supported Python Versions
+.. |Latest Version| image:: http://img.shields.io/pypi/v/csspin_python.svg?style=flat
+    :target: https://pypi.python.org/pypi/csspin/
+    :alt: Latest Package Version
+.. |License| image:: http://img.shields.io/pypi/l/csspin_python.svg?style=flat
+    :target: https://www.apache.org/licenses/LICENSE-2.0.txt
+    :alt: License
+.. _`csspin`: https://pypi.org/project/csspin
+.. _`debugpy`: https://pypi.org/project/debugpy
+.. _`devpi`: https://pypi.org/project/devpi
+.. _`playwright`: https://pypi.org/project/pytest-playwright
+.. _`radon`: https://pypi.org/project/radon

csspin_python-2.0.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+csspin_python/aws_auth.py,sha256=cQXz2AWW-TM-KAv8ZpXOSntTRRzvRL21f2NwMpOf3PA,7232
+csspin_python/aws_auth_schema.yaml,sha256=GgLhnwn4savhmLUcfL2eVPyNhWkiKA5tKz6y1tU1C6w,1353
+csspin_python/behave.py,sha256=iA5t-vwMDhmWoo-FHaeZ6JyIzj6k4r2WLyYa2AjXyp4,4815
+csspin_python/behave_schema.yaml,sha256=8qoOCK-uTmwgRRW29urgK0X_kgn0zO0X34v89bvii2w,1241
+csspin_python/debugpy.py,sha256=v0ZZopv5TNoSaFf2kiePsw9OmhBpjfOBFh0u71jTcnQ,962
+csspin_python/debugpy_schema.yaml,sha256=BeH30nSirDYctkdhS9xMXUG5htj3PED_ZjmxPG5WRUc,364
+csspin_python/devpi.py,sha256=2NhGYzq4aVzDa_d80uItUlYM9cA0uRFQ4rvnCryxL2k,2213
+csspin_python/devpi_schema.yaml,sha256=2gPATWjVcfvCTrGZX2FK6wH8hh9KS0XzZ35JvZeJGEU,487
+csspin_python/playwright.py,sha256=nYuPjuTfGx_6QPYsUpr-eAZARyXX_hZF8D4AxeI2u1s,4003
+csspin_python/playwright_schema.yaml,sha256=WFMok7dB7G6L8f8y_2_RKHjGe4ww1iUUS4tqCoUI1FE,1054
+csspin_python/pytest.py,sha256=EwxPynyPWS72NTtIah1jUGVa7fJYY8I2_NQz0y0U7Os,2978
+csspin_python/pytest_schema.yaml,sha256=1bF8hNsJfV-LHUwGBBJ3GnQOZJiIQkG81DCBma2MalU,809
+csspin_python/python.py,sha256=lWFSBeeqq3wM_DkR_zv3v9QlagXSZ-UMALhzxoAVXlY,30553
+csspin_python/python_schema.yaml,sha256=lhqZmepoGdWlBd27Bu3ErUDNtMLPM9oQ_fh71cdc4a8,4823
+csspin_python/radon.py,sha256=OSV0vTz7SMMHC82jUvWsBq6vtWolOjdiZ2bBdxplVJ4,1744
+csspin_python/radon_schema.yaml,sha256=rlRzXw5z4XbjOVznRiUxWGP4E9hx1Jm-gGw1iQiYzE0,548
+csspin_python-2.0.0.dist-info/licenses/LICENSE,sha256=4MAecetnRTQw5DlHtiikDSzKWO1xVLwzM5_DsPMYlnE,10172
+csspin_python-2.0.0.dist-info/METADATA,sha256=7I3BD1CdoU9z-1q4qvec-XFeB7UL_q1GLAe3-meg1so,4184
+csspin_python-2.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+csspin_python-2.0.0.dist-info/top_level.txt,sha256=QSeglMEGbFu1z4L6MCQYwo01NgL0KojWvC4rzgMQ8gU,14
+csspin_python-2.0.0.dist-info/RECORD,,

csspin_python-2.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

csspin_python-2.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,176 @@
+                                Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

csspin_python-2.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+csspin_python