pyright-to-gitlab 1.0.1__tar.gz → 1.1.0__tar.gz

{pyright_to_gitlab-1.0.1 → pyright_to_gitlab-1.1.0}/.github/workflows/python.yml

@@ -4,11 +4,11 @@ on: [push]
 
 jobs:
   testing:
-     name: Testing
+     name: 🧪
      uses: ./.github/workflows/testing.yml
 
   build:
-    name: Build package 📦
+    name: Build 🐍📦
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -28,7 +28,7 @@ jobs:
 
   publish-to-pypi:
     name: >-
-      Publish Python 🐍 distribution 📦 to PyPI
+      🐍📦 to PyPI
     needs: [testing]
     if: success() && startsWith(github.ref, 'refs/tags/v')
     runs-on: ubuntu-latest
@@ -49,8 +49,7 @@ jobs:
 
   github-release:
     name: >-
-      Sign the Python 🐍 distribution 📦 with Sigstore
-      and upload them to GitHub Release
+      Sign 🐍📦 with Sigstore and upload them to GitHub Release
     needs: [testing]
     if: success() && startsWith(github.ref, 'refs/tags/v')
     runs-on: ubuntu-latest

pyright_to_gitlab-1.1.0/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [Upcoming]
+## [1.1.0] - 2025-06-03
+### Added
+- Support for -i/--input and -o/--output options to specify input and output files.
+
+## [1.0.2] - 2025-06-02
+### Added
+- URLs and topics to pyproject.toml for PyPI metadata.
+- Advertise the no-dependency in the README.md.
+
+## [1.0.1] - 2025-06-02
+- Support for custom path prefix with the `--prefix` option.
+## [1.0.0] - 2025-06-02
+Initial release.
+

pyright_to_gitlab-1.1.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: pyright-to-gitlab
+Version: 1.1.0
+Summary: Convert Pyright JSON output to GitLab CI/CD format
+Project-URL: homepage, https://github.com/schollm/pyright-to-gitlab/
+Project-URL: repository, https://github.com/schollm/pyright-to-gitlab/
+Project-URL: pypi, https://pypi.org/project/pyright-to-gitlab
+Author: Micha Schöll
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ci/cd,gitlab,pyright
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+# pyright to gitlab
+Simple zero-dependency Python script to convert a pyright --outputjson to a gitlab 
+code-quality report.
+
+## Usage
+Run the script with the path to the pyright output file:
+```shell
+$ pip install pyright-to-gitlab
+$  pyright . --outputjson | pyright-to-gitlab > code-quality.json 
+```
+
+Alternatively, the module can be called:
+```shell
+$ pip install pyright-to-gitlab
+$  pyright . --outputjson | python -m pyright_to_gitlab > code-quality.json 
+```
+### Custom path prefix
+The `--prefix` option adds a custom prefix to the file paths in the output. This is
+useful if the paths in the pyright output are not relative to the root of the repository.
+
+
+```shell
+$  pyright . --outputjson | pyright-to-gitlab --prefix my-app/ > code-quality.json 
+```
+
+## Testing
+To run the tests, execute
+```shell
+$ uv run pytest tests/
+```

{pyright_to_gitlab-1.0.1 → pyright_to_gitlab-1.1.0}/README.md

@@ -1,5 +1,6 @@
 # pyright to gitlab
-Simple Python script to convert a pyright --outputjson to a gitlab code-quality report.
+Simple zero-dependency Python script to convert a pyright --outputjson to a gitlab 
+code-quality report.
 
 ## Usage
 Run the script with the path to the pyright output file:

{pyright_to_gitlab-1.0.1 → pyright_to_gitlab-1.1.0}/pyproject.toml

@@ -1,13 +1,36 @@
 [project]
 name = "pyright-to-gitlab"
-version = "1.0.1"
+version = "1.1.0"
 description = "Convert Pyright JSON output to GitLab CI/CD format"
 readme = "README.md"
 requires-python = ">=3.6"
-authors = [
-    { name = "Micha Schöll", email = "" }
+authors = [{ name = "Micha Schöll", email = "" }]
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = [ "ci/cd", "pyright", 'gitlab' ]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Software Development",
+    "Topic :: Utilities",
+    "Typing :: Typed",
 ]
-license = { file = "LICENSE" }
+
+[project.urls]
+homepage  = "https://github.com/schollm/pyright-to-gitlab/"
+repository = "https://github.com/schollm/pyright-to-gitlab/"
+pypi = "https://pypi.org/project/pyright-to-gitlab"
+
 [project.scripts]
 pyrigh-to-gitlab = 'pyright_to_gitlab:main'
 

{pyright_to_gitlab-1.0.1 → pyright_to_gitlab-1.1.0}/src/pyright_to_gitlab.py

@@ -4,10 +4,11 @@ import argparse
 import hashlib
 import json
 import sys
-from typing import cast
+import textwrap
+from typing import TextIO, cast
 
 
-def _pyright_to_gitlab(prefix: str = "") -> str:
+def _pyright_to_gitlab(input_: TextIO, prefix: str = "") -> str:
     """Convert pyright.json output to GitLab Code Quality report format.
 
     :arg prefix: A string to prepend to each file path in the output.
@@ -17,7 +18,7 @@ def _pyright_to_gitlab(prefix: str = "") -> str:
     Pyright format at https://github.com/microsoft/pyright/blob/main/docs/command-line.md
     Gitlab format at https://docs.gitlab.com/ci/testing/code_quality/#code-quality-report-format
     """
-    data = cast("dict", json.load(sys.stdin))
+    data = cast("dict", json.load(input_))
 
     issues = []
     for issue in data.get("generalDiagnostics", []):
@@ -49,17 +50,42 @@ def _pyright_to_gitlab(prefix: str = "") -> str:
 def main() -> None:
     """Parse arguments and call the conversion function."""
     parser = argparse.ArgumentParser(
-        description="Convert pyright.json to GitLab Code Quality report."
+        description=textwrap.dedent("""
+        Convert pyright.json to GitLab Code Quality report.
+        By default, reads from stdin and writes to stdout."""),
+        epilog=textwrap.dedent(
+            """
+
+        Example usage:
+        > python pyright . --outputjson | pyright-to-gitlab > gitlab_code_quality.json
+        > pyright-to-gitlab -i pyright.json -o gitlab_code_quality.json
+        """
+        ),
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument(
+        "-i",
+        "--input",
+        type=argparse.FileType("r"),
+        default=sys.stdin,
+        help="Input file (default: stdin)",
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        type=argparse.FileType("w"),
+        default=sys.stdout,
+        help="Output file (default: stdout)",
     )
     parser.add_argument(
         "--prefix",
         type=str,
         default="",
-        help="Prefix to add to each file (default: empty string)",
+        help="Prefix to add to each file entry. This can be used if pyright is run"
+        " from a subdirectory of the repository. (default: empty string)",
     )
     args = parser.parse_args()
-
-    print(_pyright_to_gitlab(prefix=args.prefix))  # noqa: T201
+    args.output.write(_pyright_to_gitlab(input_=args.input, prefix=args.prefix))
 
 
 if __name__ == "__main__":  # pragma: no cover

{pyright_to_gitlab-1.0.1 → pyright_to_gitlab-1.1.0}/tests/test_main.py

@@ -4,6 +4,10 @@ from __future__ import annotations
 
 import io
 import json
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pathlib import Path
 
 import pytest
 
@@ -93,6 +97,37 @@ def test(
     assert json.loads(captured.out) == gitlab
 
 
+@pytest.mark.parametrize(
+    ("pyright", "gitlab"),
+    [
+        ({}, []),  # Empty input should yield empty output
+        (PYRIGHT, GITLAB),
+    ],
+)
+def test_input_output_file(
+    monkeypatch: pytest.MonkeyPatch,
+    tmp_path: Path,
+    pyright: dict,
+    gitlab: list[dict],
+) -> None:
+    """Test that the pyright.json is converted to GitLab Code Quality report format."""
+    input_file = tmp_path / "pyright.json"
+    input_file.write_text(json.dumps(pyright))
+    output_file = tmp_path / "gitlab.json"
+    monkeypatch.setattr(
+        "sys.argv",
+        [
+            "pyright_to_gitlab.py",
+            "-i",
+            input_file.as_posix(),
+            "-o",
+            output_file.as_posix(),
+        ],
+    )
+    main()
+    assert json.loads(output_file.read_text("utf-8")) == gitlab
+
+
 @pytest.mark.parametrize(
     ("pyright", "gitlab"),
     [

{pyright_to_gitlab-1.0.1 → pyright_to_gitlab-1.1.0}/uv.lock

@@ -601,7 +601,7 @@ wheels = [
 
 [[package]]
 name = "pyright-to-gitlab"
-version = "1.0.1"
+version = "1.1.0"
 source = { editable = "." }
 
 [package.dev-dependencies]

pyright_to_gitlab-1.0.1/CHANGELOG.md

@@ -1,11 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-
-## [Upcoming]
-
-## [1.0.0] - 2025-06-02
-Initial release.

pyright_to_gitlab-1.0.1/PKG-INFO

@@ -1,59 +0,0 @@
-Metadata-Version: 2.4
-Name: pyright-to-gitlab
-Version: 1.0.1
-Summary: Convert Pyright JSON output to GitLab CI/CD format
-Author: Micha Schöll
-License: MIT License
-        
-        Copyright (c) 2025 Micha Schöll
-        
-        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.
-License-File: LICENSE
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-
-# pyright to gitlab
-Simple Python script to convert a pyright --outputjson to a gitlab code-quality report.
-
-## Usage
-Run the script with the path to the pyright output file:
-```shell
-$ pip install pyright-to-gitlab
-$  pyright . --outputjson | pyright-to-gitlab > code-quality.json 
-```
-
-Alternatively, the module can be called:
-```shell
-$ pip install pyright-to-gitlab
-$  pyright . --outputjson | python -m pyright_to_gitlab > code-quality.json 
-```
-### Custom path prefix
-The `--prefix` option adds a custom prefix to the file paths in the output. This is
-useful if the paths in the pyright output are not relative to the root of the repository.
-
-
-```shell
-$  pyright . --outputjson | pyright-to-gitlab --prefix my-app/ > code-quality.json 
-```
-
-## Testing
-To run the tests, execute
-```shell
-$ uv run pytest tests/
-```