jaymd96-pants-baseline 0.1.0__py3-none-any.whl

jaymd96_pants_baseline-0.1.0.dist-info/METADATA

@@ -0,0 +1,385 @@
+Metadata-Version: 2.4
+Name: jaymd96-pants-baseline
+Version: 0.1.0
+Summary: Opinionated Python code quality baseline plugin for Pants build system
+Project-URL: Homepage, https://github.com/jaymd96/pants-baseline
+Project-URL: Repository, https://github.com/jaymd96/pants-baseline.git
+Project-URL: Documentation, https://github.com/jaymd96/pants-baseline#readme
+Author: James
+License: Apache-2.0
+License-File: LICENSE
+Keywords: baseline,linting,pants,plugin,pytest,python,quality,ruff,ty
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Plugins
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: <4,>=3.11
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: ruff>=0.2.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# jaymd96-pants-baseline
+
+An opinionated Python code quality baseline plugin for the [Pants](https://www.pantsbuild.org/) build system.
+
+## Overview
+
+This plugin integrates modern, high-performance tools from the Astral ecosystem to enforce consistent code quality standards across Python projects:
+
+| Tool | Purpose | Performance |
+|------|---------|-------------|
+| **Ruff** | Linting & Formatting | 100-1000x faster than Flake8/Black |
+| **ty** | Type Checking | 10-60x faster than MyPy |
+| **uv** | Dependency Security Audit | 10-100x faster than pip |
+| **pytest** | Testing with Coverage | Industry standard |
+
+## Installation
+
+Add the plugin to your `pants.toml`:
+
+```toml
+[GLOBAL]
+backend_packages = [
+    "pants.backend.python",
+    "pants_baseline",
+]
+
+plugins = [
+    "jaymd96-pants-baseline==0.1.0",
+]
+```
+
+## Quick Start
+
+### 1. Define a baseline project
+
+Create a `BUILD` file in your project root:
+
+```python
+baseline_python_project(
+    name="my_project",
+    sources=["src/**/*.py"],
+    test_sources=["tests/**/*.py"],
+    python_version="3.11",
+    line_length=120,
+    strict=True,
+    coverage_threshold=80,
+)
+```
+
+### 2. Run quality checks
+
+```bash
+# Lint with Ruff
+pants baseline-lint ::
+
+# Format with Ruff
+pants baseline-fmt ::
+
+# Type check with ty
+pants baseline-typecheck ::
+
+# Run tests with coverage
+pants baseline-test ::
+
+# Security audit with uv
+pants baseline-audit ::
+```
+
+## Configuration
+
+### Global Configuration (`pants.toml`)
+
+```toml
+[python-baseline]
+# Enable/disable all baseline checks
+enabled = true
+
+# Target Python version
+python_version = "3.11"
+
+# Maximum line length
+line_length = 120
+
+# Source and test directories
+src_roots = ["src"]
+test_roots = ["tests"]
+
+# Minimum coverage threshold
+coverage_threshold = 80
+
+# Enable strict mode for all tools
+strict_mode = true
+
+# Patterns to exclude
+exclude_patterns = [
+    ".venv",
+    "__pycache__",
+    "migrations",
+]
+```
+
+### Ruff Configuration
+
+```toml
+[ruff]
+version = "0.2.0"
+
+# Lint rules to enable
+select = [
+    "E",      # pycodestyle errors
+    "W",      # pycodestyle warnings
+    "F",      # pyflakes
+    "I",      # isort
+    "N",      # pep8-naming
+    "UP",     # pyupgrade
+    "B",      # flake8-bugbear
+    "C4",     # flake8-comprehensions
+    "SIM",    # flake8-simplify
+    "RUF",    # Ruff-specific
+]
+
+# Rules to ignore
+ignore = ["E501"]
+
+# Formatting options
+quote_style = "double"
+indent_style = "space"
+
+# Auto-fix options
+fix = true
+unsafe_fixes = false
+```
+
+### ty Configuration
+
+```toml
+[ty]
+version = "0.1.0"
+
+# Enable strict type checking
+strict = true
+
+# Reporting options
+report_missing_imports = true
+report_unused_imports = true
+report_unused_variables = true
+
+# Include/exclude paths
+include = ["src", "tests"]
+exclude = [".venv", "dist"]
+
+# Output format (text, json, github)
+output_format = "text"
+```
+
+### uv Configuration
+
+```toml
+[uv]
+version = "0.5.0"
+
+# Security auditing
+audit_enabled = true
+audit_ignore_vulns = []
+audit_fail_on_warning = false
+
+# Lock file
+lock_file = "uv.lock"
+require_lock = true
+
+# Output format
+output_format = "text"
+```
+
+## Target Fields
+
+The `baseline_python_project` target supports the following fields:
+
+| Field | Type | Default | Description |
+|-------|------|---------|-------------|
+| `sources` | `list[str]` | `["**/*.py"]` | Python source file patterns |
+| `test_sources` | `list[str]` | `["tests/**/*.py"]` | Test file patterns |
+| `python_version` | `str` | `"3.11"` | Target Python version |
+| `line_length` | `int` | `120` | Maximum line length |
+| `strict` | `bool` | `True` | Enable strict mode |
+| `coverage_threshold` | `int` | `80` | Minimum coverage % |
+| `skip_lint` | `bool` | `False` | Skip Ruff linting |
+| `skip_fmt` | `bool` | `False` | Skip Ruff formatting |
+| `skip_typecheck` | `bool` | `False` | Skip ty type checking |
+| `skip_test` | `bool` | `False` | Skip pytest |
+| `skip_audit` | `bool` | `False` | Skip uv security audit |
+
+## Goals
+
+### `baseline-lint`
+
+Run Ruff linting on Python files.
+
+```bash
+pants baseline-lint src/::
+```
+
+### `baseline-fmt`
+
+Format Python files with Ruff.
+
+```bash
+pants baseline-fmt src/::
+
+# Check formatting without modifying files
+pants baseline-fmt --check src/::
+```
+
+### `baseline-typecheck`
+
+Run ty type checking.
+
+```bash
+pants baseline-typecheck src/::
+```
+
+### `baseline-test`
+
+Run pytest with coverage.
+
+```bash
+pants baseline-test tests/::
+
+# Run specific test markers
+pants baseline-test --pytest-args="-m unit" tests/::
+```
+
+### `baseline-audit`
+
+Run uv security audit on dependencies.
+
+```bash
+pants baseline-audit ::
+
+# Ignore specific vulnerabilities
+pants --uv-audit-ignore-vulns="['GHSA-xxxx']" baseline-audit ::
+```
+
+## Example Project Structure
+
+```
+my-project/
+├── BUILD
+├── pants.toml
+├── pyproject.toml
+├── uv.lock
+├── src/
+│   └── my_package/
+│       ├── BUILD
+│       ├── __init__.py
+│       └── main.py
+└── tests/
+    ├── BUILD
+    ├── conftest.py
+    └── test_main.py
+```
+
+### Root `BUILD` file
+
+```python
+baseline_python_project(
+    name="my_project",
+    sources=["src/**/*.py"],
+    test_sources=["tests/**/*.py"],
+)
+```
+
+### `pants.toml`
+
+```toml
+[GLOBAL]
+pants_version = "2.20.0"
+backend_packages = [
+    "pants.backend.python",
+    "pants_baseline",
+]
+plugins = ["jaymd96-pants-baseline==0.1.0"]
+
+[python]
+interpreter_constraints = ["CPython>=3.11,<4"]
+
+[python-baseline]
+python_version = "3.11"
+line_length = 120
+coverage_threshold = 80
+
+[ruff]
+select = ["E", "F", "I", "B", "UP", "RUF"]
+
+[ty]
+strict = true
+```
+
+## Why This Stack?
+
+### Performance Comparison
+
+| Task | Traditional Stack | Baseline Stack | Speedup |
+|------|-------------------|----------------|---------|
+| Lint (50K LOC) | 20s (Flake8) | 0.4s (Ruff) | **50x** |
+| Format (50K LOC) | 8s (Black) | 0.3s (Ruff) | **26x** |
+| Type Check | 45s (MyPy) | 4.7ms (ty) | **9500x** |
+| Pre-commit | 18s | 0.3s | **60x** |
+
+### Tool Consolidation
+
+| Traditional | Baseline |
+|-------------|----------|
+| Black | Ruff format |
+| isort | Ruff (I rules) |
+| Flake8 + plugins | Ruff lint |
+| MyPy/Pyright | ty |
+| pip-audit | uv audit |
+
+## Development
+
+### Setup
+
+```bash
+cd python-baseline
+hatch env create
+```
+
+### Run tests
+
+```bash
+hatch run test
+hatch run test-cov
+```
+
+### Lint and format
+
+```bash
+hatch run lint
+hatch run fmt
+```
+
+## License
+
+Apache License 2.0
+
+## Contributing
+
+Contributions are welcome! Please read our contributing guidelines before submitting a PR.
+
+## Credits
+
+Built with tools from:
+- [Astral](https://astral.sh/) - Ruff, ty, uv
+- [Pants](https://www.pantsbuild.org/) - Build system
+- [pytest](https://docs.pytest.org/) - Testing framework

jaymd96_pants_baseline-0.1.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+pants_baseline/__about__.py,sha256=5A2jMkDInJhd3HAthalOD8OaqVZJBdl_bjVT0YZUhXc,98
+pants_baseline/__init__.py,sha256=uVRGi1D2gFjc7emmeewWdcvpO-NsUuKsMbX3rztOxWU,655
+pants_baseline/register.py,sha256=AnQrzGYcPY4f7jMvgDVvs9bo-oY1XgOAwEO3fo813yg,1656
+pants_baseline/targets.py,sha256=G8ejj3QYaGHtLHbxirTyTjnEAWYxlpHFHYKV-_B4lMo,3300
+pants_baseline/goals/__init__.py,sha256=pf6KU2CIQuDkx8ER3IS0H-kuNbBtX-AH5B5SnSP9_yw,192
+pants_baseline/goals/audit.py,sha256=e2kOEdoHnNm3AlMGBq4F9ggr0K_lLQ1X1JsTi7ycMA8,2326
+pants_baseline/goals/fmt.py,sha256=QNeQHBqR-wdLKE0oTkI3jtE3sFOmOp4EP0VXGkmG6Gg,1731
+pants_baseline/goals/lint.py,sha256=hvIRPd-zfh5zC6Q_RvEWSbqJyszGEtvCpPdKwrTe0Vo,1867
+pants_baseline/goals/test.py,sha256=cUSE7NyuXaEtZnBe22MqPAu-Fqjtn5oCpttmeU1XIk4,1590
+pants_baseline/goals/typecheck.py,sha256=LuuOW3lvzOhgsNf5-W0SC1jvNnI5Nt4ZQAGwOPg6ZoA,1706
+pants_baseline/rules/__init__.py,sha256=UpvDpGVImhRfp2_VeUNsRPGiWjBbMI6AV1-Yx3kS0Gg,252
+pants_baseline/rules/audit_rules.py,sha256=vZr8VyExobFMWeV94yqpDA2KyWFNci3-0GYYvxGCfqE,3543
+pants_baseline/rules/fmt_rules.py,sha256=cObaRCS-9sqtPUhIGBHt3vTd2oW7veHwQnmex0XLaB4,3495
+pants_baseline/rules/lint_rules.py,sha256=TLc4OU1dGQF3ZtDfXtiA1B267FQXgPGxEjIZiyja84g,3825
+pants_baseline/rules/test_rules.py,sha256=BkrFKdVqj47E8lHBqsMpSC8CteaycoYpdx2rN45VQ-E,4136
+pants_baseline/rules/typecheck_rules.py,sha256=IBBmVbm21a4jXS3YjDL_rVmkN1W8LhDDlY3QMkDID6o,3969
+pants_baseline/subsystems/__init__.py,sha256=LteH_qmUIgRAnXYmmi7f6o894QfpY3hMNH5dlvJbSoM,387
+pants_baseline/subsystems/baseline.py,sha256=M20muLytoWZnA4ZY3lkbSsdCXt6OMPH6IMJfXULAQSo,2049
+pants_baseline/subsystems/ruff.py,sha256=Yl5WB7InBRrr462aiowt6bZDPBiV6QJo5snrCcKds4E,2572
+pants_baseline/subsystems/ty.py,sha256=boUryZIlJI8dm8jcBfhwmaDlhdC4sXSNTd3pg_NdZGY,2097
+pants_baseline/subsystems/uv.py,sha256=Ws9KRZ5LVQA9FXEttMnNjw1fJrm9uE-urYo6zzePHXk,1822
+jaymd96_pants_baseline-0.1.0.dist-info/METADATA,sha256=NBXKfnOCOKSmOqhhBjbHslijx0pIqQerhrL3eWI4tg8,7934
+jaymd96_pants_baseline-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+jaymd96_pants_baseline-0.1.0.dist-info/licenses/LICENSE,sha256=oLGLZv7XKM_oKCbdMW1bZB37SXsdexmhNSuh3Xg4m4I,10754
+jaymd96_pants_baseline-0.1.0.dist-info/RECORD,,

jaymd96_pants_baseline-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

jaymd96_pants_baseline-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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
+
+   Copyright 2026 James
+
+   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.

pants_baseline/__about__.py

@@ -0,0 +1,4 @@
+"""Version information for jaymd96-pants-baseline."""
+
+__version__ = "0.1.0"
+__author__ = "James"

pants_baseline/__init__.py

@@ -0,0 +1,17 @@
+"""Pants Python Baseline Plugin.
+
+An opinionated Python code quality baseline plugin for the Pants build system.
+Integrates modern, high-performance tools from the Astral ecosystem:
+
+- **Ruff**: Ultra-fast linting and formatting (replaces Black, isort, Flake8)
+- **ty**: Next-generation type checker (10-60x faster than MyPy)
+- **uv**: Fast dependency management and security auditing
+- **pytest**: Industry-standard testing with coverage support
+
+This plugin provides sensible defaults that enforce code quality standards
+across Python projects with minimal configuration.
+"""
+
+from pants_baseline.__about__ import __version__
+
+__all__ = ["__version__"]

pants_baseline/goals/__init__.py

@@ -0,0 +1,11 @@
+"""Goals for the Python Baseline plugin."""
+
+from pants_baseline.goals import audit, fmt, lint, test, typecheck
+
+__all__ = [
+    "audit",
+    "fmt",
+    "lint",
+    "test",
+    "typecheck",
+]