Metadata-Version: 2.4
Name: irregex
Version: 0.1.0
Summary: Python integration for the irregex search and similarity engine
Keywords: code-search,regex,similarity,compression
Author: The Billy Company
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Project-URL: Homepage, https://github.com/The-Billy-Company/irregex
Project-URL: Repository, https://github.com/The-Billy-Company/irregex
Project-URL: Issues, https://github.com/The-Billy-Company/irregex/issues
Description-Content-Type: text/markdown

# irregex

Python integration for the native
[irregex](https://github.com/The-Billy-Company/billy/tree/main/libs/kernels/irregex)
search and similarity engine.

The package provides a dependency-free subprocess API for invoking an installed
`irregex` binary and decoding its NDJSON output:

```python
import irregex

matches = irregex.records(
    "context",
    "resident similarity cache",
    "-e",
    "Resident",
    "--all",
)
```

Set `IRREGEX_BIN` to an explicit executable path or place the native binary on
`PATH`. If neither is available, the API raises `ExecutableNotFound` with
installation guidance.

## Install

```console
python3 -m pip install irregex
```

This initial package is the Python bridge; native binary wheels will follow.

## License

MIT
