tox-pre-commit 0.0.1a0__py3-none-any.whl

tox_plugins/pre_commit/_plugin.py

@@ -0,0 +1,95 @@
+"""A tox plugin providing a pre-commit environment."""
+
+from __future__ import annotations
+
+import typing as _t
+from shlex import join as shlex_join
+from textwrap import dedent
+
+from tox.config.loader.memory import MemoryLoader
+from tox.plugin import impl
+
+
+if _t.TYPE_CHECKING:
+    from collections import abc as _c  # noqa: WPS347
+
+    from tox.config.sets import ConfigSet
+    from tox.session.state import State
+
+
+_PYTHON_CLI_OPTIONS = (
+    'python',
+    '-bb',
+    '-E',
+    '-s',
+    '-I',
+    '-Werror',
+)
+
+
+@impl
+def tox_extend_envs() -> _c.Iterable[str]:
+    """Declare the pre-commit environment.
+
+    :returns: The names of the tox environments this plugin provides.
+    """
+    return ('pre-commit',)
+
+
+@impl
+def tox_add_core_config(
+    core_conf: ConfigSet,  # noqa: ARG001  # pylint: disable=unused-argument
+    state: State,
+) -> None:
+    """Inject default configuration for the pre-commit environment.
+
+    :param core_conf: The core tox configuration set (unused).
+    :param state: The tox session state to inject environments into.
+    """
+    pos_args = state.conf.pos_args(to_path=None)
+    pre_commit_args = ('--all-files',) if pos_args is None else pos_args
+
+    pre_commit_cmd = (
+        *_PYTHON_CLI_OPTIONS,
+        '-m',
+        'pre_commit',
+        'run',
+        '--color=always',
+        '--show-diff-on-failure',
+        *pre_commit_args,
+    )
+
+    install_advice_cmd = (
+        *_PYTHON_CLI_OPTIONS,
+        '-c',
+        dedent("""\
+            cmd = "python -Im pre_commit install"
+            scr_width = max(len(cmd) + 10, 80)
+            sep = "=" * scr_width
+            cmd_str = "    $ " + cmd
+            print()
+            print(sep)
+            print("To install pre-commit hooks into the Git repo, run:")
+            print()
+            print(cmd_str)
+            print()
+            print(sep)
+        """),
+    )
+
+    state.conf.memory_seed_loaders['pre-commit'].append(
+        MemoryLoader(
+            base=[],
+            description=(
+                '[tox-pre-commit] Run the quality checks; '
+                'use `SKIP=id1,id2 tox r -e pre-commit` to skip checks; '
+                'use `tox r -e pre-commit -- id1 --all-files` to select checks'
+            ),
+            deps=['pre-commit'],
+            commands_pre=[],
+            commands=[shlex_join(pre_commit_cmd)],
+            commands_post=[f'-{shlex_join(install_advice_cmd)}'],
+            package='skip',
+            pass_env=['SKIP'],
+        ),
+    )

tox_pre_commit-0.0.1a0.dist-info/METADATA

@@ -0,0 +1,80 @@
+Metadata-Version: 2.4
+Name: tox-pre-commit
+Version: 0.0.1a0
+Summary: A tox plugin providing a pre-commit environment
+License-Expression: LicenseRef-MIT-NORUS
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Framework :: tox
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tox>=4.30
+Dynamic: license-file
+
+[![SWUbanner]][SWUdocs]
+
+[![tox-dev badge]][tox-dev]
+[![pre-commit.ci status badge]][pre-commit.ci results page]
+[![GH Sponsors badge]][GH Sponsors URL]
+
+[SWUbanner]:
+https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg
+[SWUdocs]:
+https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md
+
+[tox-dev]: https://github.com/tox-dev
+[tox-dev badge]:
+https://img.shields.io/badge/project-yellow?label=tox-dev&labelColor=c3cc39&color=7f833e
+
+[pre-commit.ci status badge]:
+https://results.pre-commit.ci/badge/github/tox-dev/tox-pre-commit/main.svg
+[pre-commit.ci results page]:
+https://results.pre-commit.ci/latest/github/tox-dev/tox-pre-commit/main
+
+[GH Sponsors badge]:
+https://img.shields.io/badge/%40webknjaz-transparent?logo=githubsponsors&logoColor=%23EA4AAA&label=Sponsor&color=2a313c
+[GH Sponsors URL]:
+https://github.com/sponsors/webknjaz
+
+
+# tox-pre-commit
+
+A tox plugin providing a pre-commit environment.
+
+
+## Usage
+
+Add `tox-pre-commit` to your project's `tox` requirements -- either
+in `tox.toml`:
+
+```toml
+requires = [
+  "tox-pre-commit",
+]
+```
+
+...or in `tox.ini`:
+
+```ini
+[tox]
+requires =
+  tox-pre-commit
+```
+
+Then invoke the `pre-commit` env that the plugin exposes:
+
+```console
+$ tox run -q -e pre-commit
+$ tox run -q -e pre-commit -- ruff --all-files  # narrow with posargs
+$ SKIP=mypy,ruff tox run -q -e pre-commit       # skip specific hooks
+```

tox_pre_commit-0.0.1a0.dist-info/RECORD

@@ -0,0 +1,7 @@
+tox_plugins/pre_commit/_plugin.py,sha256=R-nC1fEEbhestBv-h-TrFUfYtx1UNddkdG5kVWWDyVg,2478
+tox_pre_commit-0.0.1a0.dist-info/licenses/LICENSE,sha256=85SK-PytDx4BwMjFUg_P_2RHNZKCABJai2HQtvRimOg,2097
+tox_pre_commit-0.0.1a0.dist-info/METADATA,sha256=ClJnFqPUHXiHEwoSVynC-Di2t0em4XYMS5fH7MrV5EI,2307
+tox_pre_commit-0.0.1a0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+tox_pre_commit-0.0.1a0.dist-info/entry_points.txt,sha256=6UV5eXbV_HfEmvYvm-OK1cz7COEhcIdHO5O61JGzN9w,54
+tox_pre_commit-0.0.1a0.dist-info/top_level.txt,sha256=Yj2LDGZgdLnh1_WcouoM_F5NNdx4SK4w-ulaEBzA920,12
+tox_pre_commit-0.0.1a0.dist-info/RECORD,,

tox_pre_commit-0.0.1a0.dist-info/WHEEL

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

tox_pre_commit-0.0.1a0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[tox]
+tox-pre-commit = tox_plugins.pre_commit._plugin

tox_pre_commit-0.0.1a0.dist-info/licenses/LICENSE

@@ -0,0 +1,43 @@
+Copyright (c) 2026 Sviatoslav Sydorenko and contributors
+
+The following license is modified from the MIT license.
+
+MIT-NORUS LICENSE:
+
+The following conditions must be met by any person or organization obtaining a copy of this
+software:
+
+- You MUST not be affiliated with the Russian government or military.
+- You MUST not financially support Russia, Russian military, or Russian economy.
+- You MUST condemn Russia's genocide against Ukraine.
+- You MUST not do business with Russia or in Russia.
+
+By using this software, you publicly agree to the following:
+
+- Russian war against Ukraine is a crime against humanity.
+- Russia is responsible for death and destruction in Ukraine.
+- You will not support Russia in any way.
+- The company you work for, or the organization you represent, does not do business with or in Russia.
+- The company you work for, or the organization you represent, was not founded by, nor has it received investments from, Russian citizens.
+
+The above conditions shall be included in all copies or substantial portions of the Software.
+
+MIT LICENSE:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tox_pre_commit-0.0.1a0.dist-info/top_level.txt

@@ -0,0 +1 @@
+tox_plugins