py-ntfs-quick-index 0.1.0__tar.gz

py_ntfs_quick_index-0.1.0/.gitignore

@@ -0,0 +1,221 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# py-ntfs-quick-index local artifacts
+pnqi.index.sqlite*

py_ntfs_quick_index-0.1.0/LICENSE

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

py_ntfs_quick_index-0.1.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: py-ntfs-quick-index
+Version: 0.1.0
+Summary: Fast NTFS indexing and search for Windows amd64.
+Project-URL: Homepage, https://github.com/
+Author: py-ntfs-quick-index contributors
+License-Expression: MIT
+License-File: LICENSE
+Keywords: index,ntfs,sqlite,usn,windows
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Desktop Environment :: File Managers
+Classifier: Topic :: System :: Filesystems
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: py-admin-launch>=0.1.3
+Requires-Dist: tqdm>=4.66
+Description-Content-Type: text/markdown
+
+# py-ntfs-quick-index
+
+Fast Windows NTFS indexing and search for amd64 machines.
+
+`pnqi` uses NTFS MFT enumeration for initial indexing and the NTFS USN Journal
+for incremental refreshes. Indexes are stored as SQLite files named
+`pnqi.index.sqlite` in the volume root, for example `C:\pnqi.index.sqlite`.
+
+## Requirements
+
+- Windows only
+- amd64 / x86_64 CPU only
+- Administrator privileges
+- NTFS volumes only
+- Python 3.10+
+
+The program elevates only at startup through
+[`py-admin-launch`](https://pypi.org/project/py-admin-launch/). Internal library
+calls require the already-elevated process and do not trigger additional UAC
+prompts.
+
+## Install
+
+```powershell
+python -m pip install -e .
+```
+
+## CLI
+
+Create or replace an index for a folder:
+
+```powershell
+pnqi index C:\
+```
+
+Search with `*` wildcards. `*` matches any string, including `\`.
+
+```powershell
+pnqi search "C:\Users\*\Desktop\*.pdf"
+```
+
+Show descendants sorted by recursive size:
+
+```powershell
+pnqi sizes C:\Users --limit 100
+```
+
+Show only direct children:
+
+```powershell
+pnqi sizes C:\Users --direct
+```
+
+CLI progress bars use `tqdm`, and `Ctrl+C` cancels cleanly.
+
+## GUI
+
+```powershell
+pnqi-gui
+```
+
+The GUI supports creating indexes, searching wildcard paths, browsing indexed
+folders, and viewing recursive sizes. During long operations the interface is
+locked except for Cancel. Cancelled index builds write only to a temporary
+SQLite file and do not replace the existing index.
+
+## Incremental Updates
+
+On startup, and before searches or browsing, `pnqi` checks existing
+`pnqi.index.sqlite` files and replays USN Journal changes into SQLite. If the
+USN Journal was recreated or no longer contains the required history, `pnqi`
+reports that the index must be recreated.

py_ntfs_quick_index-0.1.0/README.md

@@ -0,0 +1,72 @@
+# py-ntfs-quick-index
+
+Fast Windows NTFS indexing and search for amd64 machines.
+
+`pnqi` uses NTFS MFT enumeration for initial indexing and the NTFS USN Journal
+for incremental refreshes. Indexes are stored as SQLite files named
+`pnqi.index.sqlite` in the volume root, for example `C:\pnqi.index.sqlite`.
+
+## Requirements
+
+- Windows only
+- amd64 / x86_64 CPU only
+- Administrator privileges
+- NTFS volumes only
+- Python 3.10+
+
+The program elevates only at startup through
+[`py-admin-launch`](https://pypi.org/project/py-admin-launch/). Internal library
+calls require the already-elevated process and do not trigger additional UAC
+prompts.
+
+## Install
+
+```powershell
+python -m pip install -e .
+```
+
+## CLI
+
+Create or replace an index for a folder:
+
+```powershell
+pnqi index C:\
+```
+
+Search with `*` wildcards. `*` matches any string, including `\`.
+
+```powershell
+pnqi search "C:\Users\*\Desktop\*.pdf"
+```
+
+Show descendants sorted by recursive size:
+
+```powershell
+pnqi sizes C:\Users --limit 100
+```
+
+Show only direct children:
+
+```powershell
+pnqi sizes C:\Users --direct
+```
+
+CLI progress bars use `tqdm`, and `Ctrl+C` cancels cleanly.
+
+## GUI
+
+```powershell
+pnqi-gui
+```
+
+The GUI supports creating indexes, searching wildcard paths, browsing indexed
+folders, and viewing recursive sizes. During long operations the interface is
+locked except for Cancel. Cancelled index builds write only to a temporary
+SQLite file and do not replace the existing index.
+
+## Incremental Updates
+
+On startup, and before searches or browsing, `pnqi` checks existing
+`pnqi.index.sqlite` files and replays USN Journal changes into SQLite. If the
+USN Journal was recreated or no longer contains the required history, `pnqi`
+reports that the index must be recreated.

py_ntfs_quick_index-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["hatchling>=1.25"]
+build-backend = "hatchling.build"
+
+[project]
+name = "py-ntfs-quick-index"
+version = "0.1.0"
+description = "Fast NTFS indexing and search for Windows amd64."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+  { name = "py-ntfs-quick-index contributors" }
+]
+keywords = ["ntfs", "usn", "index", "windows", "sqlite"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Environment :: Win32 (MS Windows)",
+  "Intended Audience :: End Users/Desktop",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: Microsoft :: Windows",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: Desktop Environment :: File Managers",
+  "Topic :: System :: Filesystems",
+  "Topic :: Utilities",
+]
+dependencies = [
+  "py-admin-launch>=0.1.3",
+  "tqdm>=4.66",
+]
+
+[project.urls]
+Homepage = "https://github.com/"
+
+[project.scripts]
+pnqi = "pnqi.cli:main"
+pnqi-gui = "pnqi.gui:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pnqi"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+

py_ntfs_quick_index-0.1.0/src/pnqi/__init__.py

@@ -0,0 +1,8 @@
+"""py-ntfs-quick-index package."""
+
+from __future__ import annotations
+
+__app_name__ = "py-ntfs-quick-index"
+__version__ = "0.1.0"
+INDEX_FILENAME = "pnqi.index.sqlite"
+

py_ntfs_quick_index-0.1.0/src/pnqi/__main__.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from .cli import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())
+

py_ntfs_quick_index-0.1.0/src/pnqi/admin.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+import os
+import sys
+from collections.abc import Sequence
+
+from .errors import NotAdminError
+from .platform import is_admin, validate_supported_platform
+
+ELEVATED_CHILD_FLAG = "--pnqi-elevated-child"
+
+
+def without_elevated_flag(argv: Sequence[str]) -> list[str]:
+    return [arg for arg in argv if arg != ELEVATED_CHILD_FLAG]
+
+
+def ensure_startup_admin(argv: Sequence[str] | None = None, *, gui: bool = False) -> bool:
+    """Ensure the process is elevated once, at program startup.
+
+    Returns True in the process that should continue. Returns False after
+    requesting elevation from the original process.
+    """
+
+    validate_supported_platform()
+    args = list(sys.argv[1:] if argv is None else argv)
+    if is_admin():
+        return True
+    if ELEVATED_CHILD_FLAG in args:
+        raise NotAdminError("Elevation was requested but administrator rights are still missing.")
+
+    from py_admin_launch import AdminLaunchError, launch
+
+    child_args = [arg for arg in args if arg != ELEVATED_CHILD_FLAG]
+    if gui and "--gui" not in child_args:
+        child_args.insert(0, "--gui")
+    command = [sys.executable, "-m", "pnqi", ELEVATED_CHILD_FLAG, *child_args]
+    try:
+        launch(command, cwd=os.getcwd(), wait=False)
+    except (AdminLaunchError, OSError) as exc:
+        raise NotAdminError(f"Could not launch administrator process: {exc}") from exc
+    return False

py_ntfs_quick_index-0.1.0/src/pnqi/cli.py

@@ -0,0 +1,157 @@
+from __future__ import annotations
+
+import argparse
+import sys
+from collections.abc import Callable
+
+from tqdm import tqdm
+
+from .admin import ELEVATED_CHILD_FLAG, ensure_startup_admin, without_elevated_flag
+from .errors import OperationCancelled, PnqiError
+from .formatting import human_size
+from .indexer import build_index, list_sizes, refresh_known_indexes, search
+from .progress import CancellationToken, ProgressUpdate
+
+
+class TqdmProgress:
+    def __init__(self) -> None:
+        self._bars: dict[str, tqdm] = {}
+
+    def close(self) -> None:
+        for bar in self._bars.values():
+            bar.close()
+        self._bars.clear()
+
+    def __call__(self, update: ProgressUpdate) -> None:
+        total = update.total
+        current = update.current
+        key = update.stage
+        bar = self._bars.get(key)
+        if bar is None:
+            bar = tqdm(
+                total=total,
+                desc=key,
+                unit="item",
+                dynamic_ncols=True,
+                leave=key == "done",
+            )
+            self._bars[key] = bar
+        elif total is not None and bar.total != total:
+            bar.total = total
+            bar.refresh()
+        if current is not None:
+            delta = current - int(bar.n)
+            if delta > 0:
+                bar.update(delta)
+            elif delta < 0:
+                bar.n = current
+                bar.refresh()
+        if update.message:
+            bar.set_postfix_str(update.message[:80])
+        if update.stage == "done":
+            bar.close()
+
+
+def _add_common(parser: argparse.ArgumentParser) -> None:
+    parser.add_argument(
+        "--skip-startup-refresh",
+        action="store_true",
+        help="do not refresh existing pnqi.index.sqlite files at startup",
+    )
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="pnqi",
+        description="Fast NTFS index and search tool for Windows amd64.",
+    )
+    parser.add_argument("--gui", action="store_true", help=argparse.SUPPRESS)
+    parser.add_argument(ELEVATED_CHILD_FLAG, nargs="?", help=argparse.SUPPRESS)
+    _add_common(parser)
+    subparsers = parser.add_subparsers(dest="command")
+
+    index_parser = subparsers.add_parser("index", help="create or replace an index for a folder")
+    index_parser.add_argument("path", help="folder to index")
+
+    search_parser = subparsers.add_parser("search", help="search indexed files by a * wildcard path")
+    search_parser.add_argument("pattern", help="path pattern; * matches any string including backslashes")
+    search_parser.add_argument("--limit", type=int, default=0, help="maximum number of rows to print")
+
+    sizes_parser = subparsers.add_parser(
+        "sizes",
+        help="show files and folders sorted by recursive size descending",
+    )
+    sizes_parser.add_argument("path", help="folder to inspect")
+    sizes_parser.add_argument(
+        "--direct",
+        action="store_true",
+        help="show only direct children instead of all descendants",
+    )
+    sizes_parser.add_argument("--limit", type=int, default=0, help="maximum number of rows to print")
+    return parser
+
+
+def _refresh_startup(args: argparse.Namespace, progress: Callable[[ProgressUpdate], None], token: CancellationToken) -> None:
+    if args.skip_startup_refresh:
+        return
+    refresh_known_indexes(progress=progress, token=token)
+
+
+def run(argv: list[str] | None = None) -> int:
+    parser = build_parser()
+    raw_args = list(sys.argv[1:] if argv is None else argv)
+    args = parser.parse_args(without_elevated_flag(raw_args))
+    if args.gui:
+        from .gui import main as gui_main
+
+        return gui_main(without_elevated_flag(raw_args))
+
+    if args.command is None:
+        parser.print_help()
+        return 2
+
+    if not ensure_startup_admin(raw_args):
+        print("Requested administrator privileges; the elevated pnqi process will continue.")
+        return 0
+
+    token = CancellationToken()
+    progress = TqdmProgress()
+    try:
+        _refresh_startup(args, progress, token)
+        if args.command == "index":
+            index_path = build_index(args.path, progress=progress, token=token)
+            print(f"Index written: {index_path}")
+        elif args.command == "search":
+            rows = search(args.pattern, progress=progress, token=token)
+            shown = rows if args.limit <= 0 else rows[: args.limit]
+            for entry in shown:
+                print(f"{entry.display_size:>12}  {entry.path}")
+            if args.limit > 0 and len(rows) > args.limit:
+                print(f"... {len(rows) - args.limit} more")
+        elif args.command == "sizes":
+            rows = list_sizes(args.path, recursive=not args.direct, progress=progress, token=token)
+            shown = rows if args.limit <= 0 else rows[: args.limit]
+            for entry in shown:
+                print(f"{human_size(entry.tree_size if entry.is_dir else entry.size):>12}  {entry.path}")
+            if args.limit > 0 and len(rows) > args.limit:
+                print(f"... {len(rows) - args.limit} more")
+        else:
+            parser.error(f"unknown command: {args.command}")
+        return 0
+    except KeyboardInterrupt:
+        token.cancel()
+        print("", file=sys.stderr)
+        print("Cancelled.", file=sys.stderr)
+        return 130
+    except OperationCancelled:
+        print("Cancelled.", file=sys.stderr)
+        return 130
+    except PnqiError as exc:
+        print(f"pnqi: {exc}", file=sys.stderr)
+        return 1
+    finally:
+        progress.close()
+
+def main(argv: list[str] | None = None) -> int:
+    return run(argv)
+