offgrep 0.0.1__py3-none-any.whl

offgrep/__main__.py

@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+
+"""
+Call as script
+"""
+
+import sys
+
+from argparse import ArgumentParser, Namespace
+from importlib.metadata import PackageNotFoundError, version as metadata_version
+from logging import WARNING
+from pathlib import Path
+from tomllib import loads as tomli_loads
+
+
+PACKAGE_NAME = "offgrep"
+"""The package name for metadata inspection"""
+
+
+def get_file_contents(file_name: str, up_dirs: int = 0) -> str:
+    """get contents of a file in an ancestor directory
+    of the current file
+
+    ...
+    """
+    file_dir_path = Path(__file__).resolve()
+    for _ in range(up_dirs):
+        file_dir_path = file_dir_path.parent
+    #
+    file_path = file_dir_path / file_name
+    return file_path.read_text(encoding="utf-8")
+
+
+def get_metadata_version(
+    metadata_file_name: str = "pyproject.toml", up_dirs: int = 3
+) -> str:
+    """get version information from _metadata_file_name_ in an ancestor directory
+
+    ...
+    """
+    try:
+        metadata_file_contents = get_file_contents(metadata_file_name, up_dirs=up_dirs)
+    except IOError as error:
+        return str(error)
+    #
+    metadata = tomli_loads(metadata_file_contents)
+    try:
+        # logging.warning(str(metadata.items()))
+        version = metadata["project"]["version"]
+    except KeyError:
+        return f"Error: no version information in metadata from {metadata_file_name}"
+    #
+    return f"{version} (read directly from {metadata_file_name})"
+
+
+# pylint: disable=unused-argument ; functions not implemented yet
+
+
+def grep_files(arguments: Namespace) -> int:
+    """Search for text in files"""
+    return 0
+
+
+def list_files(arguments: Namespace) -> int:
+    """List files that would be searched"""
+    return 0
+
+
+# pylint: enable=unused-argument
+
+
+def main() -> int:
+    """Main script interface
+
+    Returns:
+        the script rteurncode
+    """
+    try:
+        version = metadata_version(PACKAGE_NAME)
+    except PackageNotFoundError:
+        version = get_metadata_version()
+    #
+    main_parser = ArgumentParser(
+        prog="offgrep", description="searches text in (text) files recursively"
+    )
+    main_parser.set_defaults(loglevel=WARNING, extra_ignore=".git/")
+    main_parser.add_argument("-V", "--version", action="version", version=version)
+    main_parser.add_argument(
+        "--extra-ignore",
+        help="extra ignore rules separated by comma (default: %(default)s)",
+    )
+    main_parser.add_argument(
+        "--files",
+        action="store_true",
+        help="list the files that would be searched",
+    )
+    arguments = main_parser.parse_args()
+    if arguments.files:
+        return list_files(arguments)
+    #
+    return grep_files(arguments)
+
+
+if __name__ == "__main__":
+    sys.exit(main())  # pragma: no cover
+
+# vim: fileencoding=utf-8 ts=4 sts=4 sw=4 autoindent expandtab syntax=python:

offgrep-0.0.1.dist-info/METADATA

@@ -0,0 +1,70 @@
+Metadata-Version: 2.3
+Name: offgrep
+Version: 0.0.1
+Summary: A lousy ripgrep rip-off in pure Python
+Keywords: grep,recursive
+Author: Rainer Schwarzbach
+Author-email: Rainer Schwarzbach <rainer@blackstream.de>
+License: MIT License
+         
+         Copyright (c) 2026 Rainer Schwarzbach
+         
+         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: Development Status :: 3 - Alpha
+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: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Environment :: Console
+Classifier: Topic :: Utilities
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Requires-Python: >=3.11
+Project-URL: Homepage, https://gitlab.com/blackstream-x/offgrep
+Project-URL: CI, https://gitlab.com/blackstream-x/offgrep/-/pipelines
+Project-URL: Bug Tracker, https://gitlab.com/blackstream-x/offgrep/-/issues
+Project-URL: Repository, https://gitlab.com/blackstream-x/offgrep.git
+Project-URL: Documentation, https://blackstream-x.gitlab.io/offgrep/
+Description-Content-Type: text/markdown
+
+# offgrep
+
+_A lousy **[ripgrep]** rip-off in pure Python_
+
+[ripgrep]: https://github.com/burntsushi/ripgrep
+
+Searches text in a grep-like manner in text files,
+recursively searching for files from the provided starting-point
+or from the current working directory.
+
+When doing so, **offgrep** respects ignore rules in a **.gitignore** file.
+
+This behavior is a small fraction of **ripgrep’s** capabilities,
+combined with a ridiculously low execution speed.
+
+So if you have any chance to run the original, please use **ripgrep**
+instead of **offgrep**.
+
+If you – however – are in a super restricted network (eg. government)
+without a chance to install **ripgrep**,
+but are able to install Python packages, **offgrep** might be an interesting
+alterative.

offgrep-0.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+offgrep/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+offgrep/__main__.py,sha256=xW0Obfu-dWh5DOrqtZewkFyo0Kh3-yJnLYSSbb1zNaQ,2813
+offgrep-0.0.1.dist-info/WHEEL,sha256=jK0lbM7sVtq70msNoYotEXYS3OJMDdns2CRgyjhimnE,81
+offgrep-0.0.1.dist-info/entry_points.txt,sha256=VxvvRRqIHquOqFhJ9CgDzrKmVIaz-GdkaYQx3hChfX0,78
+offgrep-0.0.1.dist-info/METADATA,sha256=OdTjvWHg29XusPOyIRQScs1vVtrEqr6uJ6F8-6kNYUo,3208
+offgrep-0.0.1.dist-info/RECORD,,

offgrep-0.0.1.dist-info/WHEEL

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

offgrep-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+offgrep = offgrep.__main__:main
+og = offgrep.__main__:main
+