pyright-to-gitlab 1.0.1__py3-none-any.whl → 1.1.0__py3-none-any.whl

pyright_to_gitlab-1.1.0.dist-info/METADATA

@@ -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.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+pyright_to_gitlab.py,sha256=i_54FlXg4RD1_1dr5Kq6onIAua2zRsi9hs_uejB_SK0,3150
+pyright_to_gitlab-1.1.0.dist-info/METADATA,sha256=9WGRB8rUH9ylhs98la_TMihlgQ6VNBe_gTAtrFOGjJk,2034
+pyright_to_gitlab-1.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyright_to_gitlab-1.1.0.dist-info/entry_points.txt,sha256=MbNff91bPuO2XhW0P03N9O1Z7xtlr3x9duU5BftRbZo,60
+pyright_to_gitlab-1.1.0.dist-info/licenses/LICENSE,sha256=tY29-MdtyUNoC3XN4IBzu_jxmb8U82z9UvLkQJuBiJM,1070
+pyright_to_gitlab-1.1.0.dist-info/RECORD,,

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.dist-info/METADATA

@@ -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/
-```

pyright_to_gitlab-1.0.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-pyright_to_gitlab.py,sha256=LbPxle60_JFBGMtPZszoNaFmnXEzfWBhc67PuZ1669g,2251
-pyright_to_gitlab-1.0.1.dist-info/METADATA,sha256=oztGH-gx0w-OAgVZ6_ezwqTHSAcXkAvhw-wnBLRxsew,2289
-pyright_to_gitlab-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pyright_to_gitlab-1.0.1.dist-info/entry_points.txt,sha256=MbNff91bPuO2XhW0P03N9O1Z7xtlr3x9duU5BftRbZo,60
-pyright_to_gitlab-1.0.1.dist-info/licenses/LICENSE,sha256=tY29-MdtyUNoC3XN4IBzu_jxmb8U82z9UvLkQJuBiJM,1070
-pyright_to_gitlab-1.0.1.dist-info/RECORD,,