Skip to main content

Fast NTFS indexing and search for Windows amd64.

Project description

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. Internal library calls require the already-elevated process and do not trigger additional UAC prompts.

Install

Install the latest release from PyPI:

python -m pip install py-ntfs-quick-index

Upgrade an existing install:

python -m pip install --upgrade py-ntfs-quick-index

For local development from a checkout:

python -m pip install -e .

CLI

Create or replace an index for a folder:

pnqi index C:\

Search with * wildcards. * matches any string, including \.

pnqi search "C:\Users\*\Desktop\*.pdf"

Show descendants sorted by recursive size:

pnqi sizes C:\Users --limit 100

Show only direct children:

pnqi sizes C:\Users --direct

CLI progress bars use tqdm, and Ctrl+C cancels cleanly.

GUI

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. Long tasks run in a worker process so NTFS MFT scans do not stall the Tk event loop. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_ntfs_quick_index-0.1.2.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_ntfs_quick_index-0.1.2-py3-none-any.whl (27.1 kB view details)

Uploaded Python 3

File details

Details for the file py_ntfs_quick_index-0.1.2.tar.gz.

File metadata

  • Download URL: py_ntfs_quick_index-0.1.2.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.5 Windows/11

File hashes

Hashes for py_ntfs_quick_index-0.1.2.tar.gz
Algorithm Hash digest
SHA256 43d003c7bbd81fca46eb5a05f98abefd920f1e553c3614402f87da5ec0cfaafd
MD5 93ab437e00c9be0f3a7c25572a212726
BLAKE2b-256 20da1022ab53680b2a48ef0612c645c2f4278c5743c047fa4530cba6914daca4

See more details on using hashes here.

File details

Details for the file py_ntfs_quick_index-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for py_ntfs_quick_index-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 91f8fa4e097c6519f12ec107cef69d02b351a848c311d4cf32d42e1bd8fdb6f4
MD5 f08a3d7a573fc62b438872b6368f0b4a
BLAKE2b-256 e752c0d6e34f348224aa8803987f12170230a06819fa0213a65da0f5315ba553

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page