kebe-ship 0.0.6__py3-none-any.whl

kebe_ship/__init__.py

@@ -0,0 +1,10 @@
+"""Utilities for accessing bundled data files.
+
+This package bundles configuration files, templates and binary resources in
+``bundled_assets/data``.  Use the functions from :mod:`bundled_assets.assets`
+to read these resources as text or bytes.
+"""
+
+from .assets import read_text, read_bytes, as_file_path
+
+__all__ = ["read_text", "read_bytes", "as_file_path"]

kebe_ship/assets.py

@@ -0,0 +1,106 @@
+"""Helper functions to access resources bundled with this package.
+
+These functions provide a high-level API to read text or binary files from
+within the installed ``bundled_assets`` package.  They rely on the
+``importlib.resources`` module, which correctly handles files inside zip
+archives (such as wheel distributions) without assuming that the data lives
+on the filesystem.  See the Python documentation for more details:
+https://docs.python.org/3/library/importlib.resources.html
+"""
+
+from __future__ import annotations
+
+from contextlib import contextmanager
+from importlib import resources
+from pathlib import Path
+from typing import Iterator
+
+
+def _resource_path(rel_path: str) -> resources.abc.Traversable:
+    """Return a Traversable pointing to a resource under ``data``.
+
+    Parameters
+    ----------
+    rel_path: str
+        The relative path under the ``data`` directory.  For example
+        ``"templates/prompt.txt"``.
+
+    Returns
+    -------
+    resources.abc.Traversable
+        An object representing the resource.  This can be passed to
+        :func:`importlib.resources.as_file` to obtain a real filesystem path.
+    """
+    base = resources.files(__package__).joinpath("data")
+    return base.joinpath(rel_path)
+
+
+def read_text(rel_path: str, encoding: str = "utf-8") -> str:
+    """Read a text resource bundled with the package.
+
+    This function reads a file located in the ``data`` directory of
+    ``bundled_assets`` and returns its contents as a string.
+
+    Parameters
+    ----------
+    rel_path: str
+        The relative path to the file inside the ``data`` directory.
+
+    encoding: str, optional
+        The text encoding to use.  Defaults to ``"utf-8"``.
+
+    Returns
+    -------
+    str
+        The decoded text contents of the file.
+    """
+    resource = _resource_path(rel_path)
+    return resource.read_text(encoding=encoding)
+
+
+def read_bytes(rel_path: str) -> bytes:
+    """Read a binary resource bundled with the package.
+
+    Parameters
+    ----------
+    rel_path: str
+        The relative path to the file inside the ``data`` directory.
+
+    Returns
+    -------
+    bytes
+        The raw bytes of the resource.
+    """
+    resource = _resource_path(rel_path)
+    return resource.read_bytes()
+
+
+@contextmanager
+def as_file_path(rel_path: str) -> Iterator[Path]:
+    """Yield a real filesystem path to a bundled resource.
+
+    Some libraries require a path on disk rather than a file-like object.
+    This context manager yields a :class:`~pathlib.Path` pointing to a
+    temporary copy of the resource if the package is installed as a zip
+    archive.  When the context exits, any temporary files are cleaned up.
+
+    Example
+    -------
+    >>> from bundled_assets.assets import as_file_path
+    >>> with as_file_path("templates/prompt.txt") as path:
+    ...     print(path.read_text())
+
+    Parameters
+    ----------
+    rel_path: str
+        The relative path to the file inside the ``data`` directory.
+
+    Yields
+    ------
+    pathlib.Path
+        A path object pointing to the resource.
+    """
+    resource = _resource_path(rel_path)
+    # resources.as_file returns a context manager that yields a real Path
+    with resources.as_file(resource) as tmp_path:
+        yield tmp_path

kebe_ship-0.0.6.dist-info/METADATA

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: kebe-ship
+Version: 0.0.6
+Summary: Example package that bundles data files.
+Author: Your Name
+License: MIT License
+        
+        Copyright (c) 2026 Your Name
+        
+        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.
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+## Bundled Assets Package
+
+This package demonstrates how to include data files in a Python package so that they can be distributed via PyPI and accessed at runtime.  It uses [`importlib.resources`](https://docs.python.org/3/library/importlib.resources.html) to read text and binary files from within the installed package.
+
+After installing this package with `pip install`, you can use the helper functions in `bundled_assets.assets` to load the bundled data files.  See the docstrings in `assets.py` for more information.

kebe_ship-0.0.6.dist-info/RECORD

@@ -0,0 +1,8 @@
+kebe_ship/__init__.py,sha256=DulURsLvuJd7Bbwyk4U0izc9a7LSiLPdE0ySgE7xxzI,359
+kebe_ship/assets.py,sha256=OswMEvD80fDILkA3iYS2pUYq7uMjRZx0BxCELWqS2o0,3235
+kebe_ship/data/tars/FlashMLA-46d64a8ebef03fa50b4ae74937276a5c940e3f95.zip,sha256=1sSELoNTDJXivMG7VAnofRyLIlrjX0tFPG2v25VJ6HE,262429
+kebe_ship-0.0.6.dist-info/licenses/LICENSE,sha256=0SJU1dVe5uk0rKC9g3BKPevyAWTYQxcqVtDVW9ORk5Y,1065
+kebe_ship-0.0.6.dist-info/METADATA,sha256=W_hSclsB7HoWJ8niP2G4PZ1o0I4Yr5fK6cELSNpeYts,2086
+kebe_ship-0.0.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kebe_ship-0.0.6.dist-info/top_level.txt,sha256=m2HIr7it44V-cGjgvCXioP-IfClk5ypCmZx5fUM3WSc,10
+kebe_ship-0.0.6.dist-info/RECORD,,

kebe_ship-0.0.6.dist-info/WHEEL

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

kebe_ship-0.0.6.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Your Name
+
+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.

kebe_ship-0.0.6.dist-info/top_level.txt

@@ -0,0 +1 @@
+kebe_ship