mddj 0.0.1__tar.gz

mddj-0.0.1/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023-present Stephen Rosen <sirosen@globus.org>
+
+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.

mddj-0.0.1/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.1
+Name: mddj
+Version: 0.0.1
+Summary: A CLI for extracting python metadata from packages
+Author-email: Stephen Rosen <sirosen@globus.org>
+License: MIT
+Project-URL: source, https://github.com/sirosen/mddj
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python
+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 :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+# mddj
+
+Your DJ of MetaData.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/mddj.svg)](https://pypi.org/project/mddj)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mddj.svg)](https://pypi.org/project/mddj)
+
+-----
+
+**Table of Contents**
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+
+## Overview
+
+A CLI for interacting with your python package metadata.
+
+Supports multiple packaging backends via a uniform interface.
+
+## Installation
+
+```console
+pipx install mddj
+```
+
+## Usage
+
+### `mddj read`
+
+Read metadata from your package by building it to an sdist and then inspecting
+that `sdist`.
+
+#### `mddj read requires-python`
+
+Show the `Requires-Python` data. Supports specialized options for parsing data
+like `--lower-bound`.
+
+See `--help` for details.
+
+## License
+
+`flake8-typing-as-t` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

mddj-0.0.1/README.md

@@ -0,0 +1,45 @@
+# mddj
+
+Your DJ of MetaData.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/mddj.svg)](https://pypi.org/project/mddj)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mddj.svg)](https://pypi.org/project/mddj)
+
+-----
+
+**Table of Contents**
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+
+## Overview
+
+A CLI for interacting with your python package metadata.
+
+Supports multiple packaging backends via a uniform interface.
+
+## Installation
+
+```console
+pipx install mddj
+```
+
+## Usage
+
+### `mddj read`
+
+Read metadata from your package by building it to an sdist and then inspecting
+that `sdist`.
+
+#### `mddj read requires-python`
+
+Show the `Requires-Python` data. Supports specialized options for parsing data
+like `--lower-bound`.
+
+See `--help` for details.
+
+## License
+
+`flake8-typing-as-t` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

mddj-0.0.1/pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mddj"
+version = "0.0.1"
+description = 'A CLI for extracting python metadata from packages'
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+keywords = []
+authors = [
+  { name = "Stephen Rosen", email = "sirosen@globus.org" },
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Programming Language :: Python",
+  "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 :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+  "importlib_metadata",
+  "build",
+  "click",
+]
+
+[project.urls]
+source = "https://github.com/sirosen/mddj"
+
+[project.scripts]
+mddj = "mddj.cli:main"
+
+
+[tool.coverage.run]
+parallel = true
+source = ["mddj"]
+[tool.coverage.paths]
+source = [
+    "src/",
+    "*/site-packages/",
+]
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+exclude_lines = [
+    # the pragma to disable coverage
+    "pragma: no cover",
+    # don't complain if tests don't hit unimplemented methods/modes
+    "raise NotImplementedError",
+    # don't check on executable components of importable modules
+    "if __name__ == .__main__.:",
+    # mypy-only code segments
+    "if t.TYPE_CHECKING:",
+    # type-checking overloads
+    "@t.overload"
+]
+
+[tool.mypy]
+strict = true
+ignore_missing_imports = true
+disallow_subclassing_any = false
+files = ["src"]

mddj-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mddj-0.0.1/src/mddj/__init__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+__all__ = ("main",)

mddj-0.0.1/src/mddj/builder.py

@@ -0,0 +1,34 @@
+import contextlib
+import pathlib
+import subprocess
+import sys
+import tempfile
+import typing as t
+
+import click
+
+
+@contextlib.contextmanager
+def ephemeral_sdist(*, capture_build_output: bool = True) -> t.Iterator[pathlib.Path]:
+    with tempfile.TemporaryDirectory() as tmpdir:
+        try:
+            subprocess.run(
+                [sys.executable, "-m", "build", "--sdist", "-o", tmpdir],
+                check=True,
+                capture_output=capture_build_output,
+            )
+        except subprocess.CalledProcessError as e:
+            if capture_build_output:
+                click.secho(
+                    "Encountered errors in build. "
+                    "Use --no-build-capture to see full details.",
+                    fg="red",
+                    err=True,
+                )
+            click.get_current_context().exit(e.returncode)
+
+        # now we have an sdist, so let's find it.
+        # the package version will be in the name, so we sniff for any .tar.gz file
+        # there will only be one file
+        sdist_path = next(pathlib.Path(tmpdir).glob("*.tar.gz"))
+        yield sdist_path

mddj-0.0.1/src/mddj/cli.py

@@ -0,0 +1,59 @@
+import click
+
+from .builder import ephemeral_sdist
+from .readers import read_from_sdist
+
+
+@click.group("mddj")
+@click.help_option("-h", "--help")
+def main() -> None:
+    """MetaData DJ"""
+
+
+@main.group("read")
+@click.help_option("-h", "--help")
+def read() -> None:
+    """Read metadata from the current project."""
+
+
+@read.command("requires-python")
+@click.help_option("-h", "--help")
+@click.option(
+    "--lower-bound",
+    is_flag=True,
+    help="Show a lower bound rather than the full Requires-Python data.",
+)
+@click.option(
+    "--no-build-capture",
+    is_flag=True,
+    help="Disable capturing of the internal package build output and errors.",
+)
+def read_requires_python(*, lower_bound: bool, no_build_capture: bool) -> None:
+    """
+    Read the 'Requires-Python' data.
+    """
+    with ephemeral_sdist(capture_build_output=not no_build_capture) as sdist_path:
+        requires_python = read_from_sdist(sdist_path, "Requires-Python")
+
+    if lower_bound:
+        click.echo(find_lower_bound(requires_python))
+    else:
+        click.echo(requires_python)
+
+
+def find_lower_bound(req: str) -> str:
+    reqs = req.split(",")
+    lower_bounds = []
+    for r in reqs:
+        if r.startswith(">="):
+            lower_bounds.append(r[2:])
+        elif r.startswith(">"):
+            raise RuntimeError(
+                "Found a > requirement, rejecting as invalid (use '>=' instead)"
+            )
+    if len(lower_bounds) > 1:
+        raise RuntimeError("Found multiple lower bounds, cannot choose one")
+    elif len(lower_bounds) == 0:
+        raise RuntimeError("Found no lower bounds")
+    else:
+        return lower_bounds[0]

mddj-0.0.1/src/mddj/readers.py

@@ -0,0 +1,21 @@
+import pathlib
+import tarfile
+
+
+def read_from_sdist(sdist_path: pathlib.Path, key: str) -> str:
+    """
+    Read a key from the PKG-INFO file in an sdist.
+    """
+    dist_name = sdist_path.name.rsplit(".", 2)[0]
+    with tarfile.open(sdist_path, "r:gz") as tf:
+        pkg_info_fp = tf.extractfile(f"{dist_name}/PKG-INFO")
+        if pkg_info_fp is None:
+            raise RuntimeError("Could not find and read PKG-INFO in sdist")
+        pkg_info = pkg_info_fp.read().decode()
+    try:
+        data_line = next(
+            line for line in pkg_info.splitlines() if line.startswith(f"{key}:")
+        )
+    except IndexError:
+        raise RuntimeError(f"Could not find '{key}' in PKG-INFO")
+    return data_line.partition(":")[2].strip()

mddj-0.0.1/src/mddj.egg-info/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.1
+Name: mddj
+Version: 0.0.1
+Summary: A CLI for extracting python metadata from packages
+Author-email: Stephen Rosen <sirosen@globus.org>
+License: MIT
+Project-URL: source, https://github.com/sirosen/mddj
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python
+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 :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+
+# mddj
+
+Your DJ of MetaData.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/mddj.svg)](https://pypi.org/project/mddj)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mddj.svg)](https://pypi.org/project/mddj)
+
+-----
+
+**Table of Contents**
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Usage](#usage)
+- [License](#license)
+
+## Overview
+
+A CLI for interacting with your python package metadata.
+
+Supports multiple packaging backends via a uniform interface.
+
+## Installation
+
+```console
+pipx install mddj
+```
+
+## Usage
+
+### `mddj read`
+
+Read metadata from your package by building it to an sdist and then inspecting
+that `sdist`.
+
+#### `mddj read requires-python`
+
+Show the `Requires-Python` data. Supports specialized options for parsing data
+like `--lower-bound`.
+
+See `--help` for details.
+
+## License
+
+`flake8-typing-as-t` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

mddj-0.0.1/src/mddj.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE.txt
+README.md
+pyproject.toml
+src/mddj/__init__.py
+src/mddj/builder.py
+src/mddj/cli.py
+src/mddj/readers.py
+src/mddj.egg-info/PKG-INFO
+src/mddj.egg-info/SOURCES.txt
+src/mddj.egg-info/dependency_links.txt
+src/mddj.egg-info/entry_points.txt
+src/mddj.egg-info/requires.txt
+src/mddj.egg-info/top_level.txt

mddj-0.0.1/src/mddj.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mddj-0.0.1/src/mddj.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mddj = mddj.cli:main

mddj-0.0.1/src/mddj.egg-info/requires.txt

@@ -0,0 +1,3 @@
+importlib_metadata
+build
+click

mddj-0.0.1/src/mddj.egg-info/top_level.txt

@@ -0,0 +1 @@
+mddj