csspin 2.0.0__py3-none-any.whl

csspin-2.0.0.dist-info/METADATA

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: csspin
+Version: 2.0.0
+Summary: Spin is a task runner that aims to solve the problems of provisioning development environments and standardizing workflows.
+Author-email: CONTACT Software GmbH <info@contact-software.com>, Frank Patz-Brockmann <frank.patz-brockmann@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: click~=8.1.8
+Requires-Dist: distro~=1.9.0
+Requires-Dist: packaging~=25.0
+Requires-Dist: path~=17.0.0
+Requires-Dist: pip>=22.0
+Requires-Dist: platformdirs~=4.3.8
+Requires-Dist: ruamel.yaml~=0.18.10
+Dynamic: license-file
+
+|Latest Version| |Python| |License|
+
+`csspin` is maintained and published by `CONTACT Software GmbH`_.
+
+`csspin` is the Python package that ships the task runner and CLI `spin` that
+aims so solve the problems of *provisioning development environments* and
+*standardizing workflows*. `spin` also automates the provisioning of tools and
+other development requirements (including language stacks like Python,
+Javascript/Node). As an example, for a project that uses Python and Javascript,
+`spin` would:
+
+* provision the requested version of Python
+* provision the requested version of Node
+* create a virtual development environment, in which the required versions of
+  Python and Node can be used
+* install tools and dependencies for development, testing, etc.
+
+All with a single command: ``spin provision``!
+
+Second, `spin` allows standardizing workflows, best practices and how
+development tools are used, especially in a development group with many similar
+projects that share practices and tools. It's plugin-based architecture allows
+to define workflows executing multiple task in sequence using a single command.
+
+By default, `spin` will automatically generate the right options and arguments
+for the tools it runs, and show the user the precise commands. As a result,
+*anyone* will be able to check out *any project*, run ``spin provision`` and
+will be all set - Running a project's test suite becomes as simple as doing
+``spin test`` etc.
+
+A comprehensive documentation will be published soon.
+
+Getting Started
+---------------
+
+`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 spin
+----------
+
+As every other command line tool, `spin` can be run from the command line. The
+command is simply called ``spin``. To see the available commands, run:
+
+.. code-block:: console
+
+   spin --help
+
+Leveraging `spin`'s capabilities requires a project to be set up with a
+`spinfile.yaml`. This file is a YAML file that defines the project, its tools,
+and the workflows that `spin` can leverage. The `spinfile.yaml` is the
+configuration file for `spin` and is typically located in the root directory of
+the project.
+
+A basic `spinfile.yaml` might look like this:
+
+.. code-block:: yaml
+
+    # spinfile.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]
+
+
+CPython Support Policies
+------------------------
+
+Our CPython support policy for spin aligns with the official CPython release
+schedule, encompassing versions 3.9 through 3.13 (so far).
+
+.. _`CONTACT Software GmbH`: https://contact-software.com
+.. |Python| image:: https://img.shields.io/pypi/pyversions/csspin.svg?style=flat
+    :target: https://pypi.python.org/pypi/csspin/
+    :alt: Supported Python Versions
+.. |Latest Version| image:: http://img.shields.io/pypi/v/csspin.svg?style=flat
+    :target: https://pypi.python.org/pypi/csspin/
+    :alt: Latest Package Version
+.. |License| image:: http://img.shields.io/pypi/l/csspin.svg?style=flat
+    :target: https://www.apache.org/licenses/LICENSE-2.0.txt
+    :alt: License

csspin-2.0.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+csspin/__init__.py,sha256=rGwp141gOhnZ7BgeFXdzXgiJcB04qHWTyxjUhD1BMeE,42303
+csspin/__main__.py,sha256=a5WW35iuHx70zgCR9_YIfTbbmzXquLTQCUFB2tWNSYI,696
+csspin/cli.py,sha256=xFi7neEWWCqVD9Egi1pVTslLAJcj46QDG3rgW0bEtiY,24108
+csspin/schema.py,sha256=BgU4cBKncAcfs0JMtxbrP5rfZKCCqebK-h5oS_aee3A,6695
+csspin/schema.yaml,sha256=AI4KE7PrRSycHP4OX8kY6CDDTRmlNJYC2eGXJRblLBw,3906
+csspin/tree.py,sha256=wBpxSRSCM_Xno6B-NErQZvQjFsBeJgjKGUW3z6fYFnc,27426
+csspin/builtin/__init__.py,sha256=GCqGx_KjhY3CTQmA4aht4qFdkz0JDeBynzqEa1xKysU,10227
+csspin-2.0.0.dist-info/licenses/LICENSE,sha256=4MAecetnRTQw5DlHtiikDSzKWO1xVLwzM5_DsPMYlnE,10172
+csspin-2.0.0.dist-info/METADATA,sha256=UfTeTyRJVPtvr6R6PgGJMzVwRmt9Wb8n-dRy4H2e_Gc,5000
+csspin-2.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+csspin-2.0.0.dist-info/entry_points.txt,sha256=U-DTZGDVOHPeWL7yupAdXHqmRLiSfsvkCoSP9Rqd-X0,38
+csspin-2.0.0.dist-info/top_level.txt,sha256=MSZl-2I1Jq7k7zptSZmZTzhNhff4mOQuEnwxYUYu8ls,7
+csspin-2.0.0.dist-info/RECORD,,

csspin-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-2.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+spin = csspin:_main

csspin-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-2.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+csspin