Skip to main content

SQL-like interface for querying files in your filesystem

Project description

File Query

A SQL-like interface for querying files in your filesystem.

Installation

# Clone the repository
git clone https://github.com/yourusername/file-query.git
cd file-query

# Install with pip
pip install -e .

# Or use UV
uv run python -m src.cli "your query"

# Install as a permanent tool with UV
uv tool install .
# This will install the 'fq' command

Usage

Command Line

The quickest way to run file-query is with UV:

uv run python -m src.cli "your query here"

After installation, you can use the shorthand command:

fq "your query here"

Basic Usage

# Find all Python files
fq "extension == 'py'"

# Find all text files and show their content
fq "extension == 'txt'" --show-content

Advanced Queries

File Query supports full SQL-like syntax:

# Find all Python files in the src directory
fq "SELECT * FROM 'src' WHERE extension == 'py'"

# Find all files larger than 100KB
fq "SELECT * FROM '.' WHERE size > 102400"

# Complex conditions
fq "SELECT * FROM '.' WHERE (extension == 'pdf' AND size > 1000000) OR (extension == 'txt' AND NOT name == 'README.txt')"

Query Syntax

File Query uses a SQL-like syntax:

SELECT * FROM 'directory_path' WHERE condition

Available Attributes

  • extension: File extension (without the dot)
  • name: Filename with extension
  • size: File size in bytes

Operators

  • Comparison: ==, !=, <, <=, >, >=
  • Logical: AND, OR, NOT

Examples

# Find all PDF files
fq "extension == 'pdf'"

# Find all files not named "main.py"
fq "NOT name == 'main.py'"

# Find all large image files
fq "SELECT * FROM '.' WHERE (extension == 'jpg' OR extension == 'png') AND size > 500000"

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

file_query_text-0.1.0.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

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

file_query_text-0.1.0-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file file_query_text-0.1.0.tar.gz.

File metadata

  • Download URL: file_query_text-0.1.0.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.2

File hashes

Hashes for file_query_text-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a79a447a749ed65990e0bc1711a15c0d4ed8e9dc7e53d2023671c969defd1838
MD5 a9a6d69e86ccaa95e91404b64db4e1d7
BLAKE2b-256 95ea34e26420fae173c5a4dbc6f83aa2951b6d241512b59489bc22b36458b45a

See more details on using hashes here.

File details

Details for the file file_query_text-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for file_query_text-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a6bd800680292671a46ebec811771a0306fe9e60f0c6822fa8f053ccf09ba208
MD5 ba943a9ab9c55a7e464fe10c84fa9e32
BLAKE2b-256 bae63b93ddef3d89ab44208b4fd2a990592e5e8eca310c2a2c9bb764940386cb

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