pqfilt 0.1.0__tar.gz

pqfilt-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: uv sync --all-extras
+      - name: Lint
+        run: uv run ruff check .
+      - name: Test
+        run: uv run pytest -v
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Set up Python
+        run: uv python install 3.12
+      - name: Install dependencies
+        run: uv sync --extra docs
+      - name: Build docs
+        run: uv run sphinx-build -W docs docs/_build/html

pqfilt-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,17 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for trusted publishing
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - run: uv build
+      - uses: pypa/gh-action-pypi-publish@release/v1

pqfilt-0.1.0/.readthedocs.yaml

@@ -0,0 +1,19 @@
+# Read the Docs configuration file
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

pqfilt-0.1.0/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "python-envs.defaultEnvManager": "ms-python.python:conda",
+    "python-envs.defaultPackageManager": "ms-python.python:conda",
+    "python-envs.pythonProjects": []
+}

pqfilt-0.1.0/LICENSE

@@ -0,0 +1,24 @@
+cd /Users/ysbach/Dropbox/github/pqfilt
+cat > LICENSE << 'EOF'
+MIT License
+
+Copyright (c) 2026 Yoonsoo P. Bach
+
+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.
+EOF

pqfilt-0.1.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: pqfilt
+Version: 0.1.0
+Summary: Generic Parquet filtering tool (CLI + API)
+Author: Yoonsoo P. Bach
+License-Expression: MIT
+License-File: LICENSE
+Keywords: data,filter,parquet,predicate-pushdown,pyarrow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Requires-Dist: click>=8.0
+Requires-Dist: pandas>=1.5
+Requires-Dist: pyarrow>=10.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# pqfilt
+
+Generic Parquet predicate-pushdown filter tool — CLI and Python API.
+
+`pqfilt` wraps `pyarrow.dataset` to let you filter Parquet files **before** they
+are fully read into memory, using row-group-level predicate pushdown.
+
+## Installation
+
+```bash
+pip install pqfilt
+# or
+uv add pqfilt
+```
+
+## Python API
+
+```python
+import pqfilt
+
+# Simple filter
+df = pqfilt.read("data.parquet", filters="vmag < 20")
+
+# AND + OR with expression syntax
+df = pqfilt.read("data.parquet", filters="(a < 30 & b > 50) | c == 1")
+
+# Tuple syntax (flat AND)
+df = pqfilt.read("data.parquet", filters=[("a", "<", 30), ("b", ">", 50)])
+
+# DNF syntax (OR of ANDs)
+df = pqfilt.read("data.parquet", filters=[
+    [("a", "<", 30)],
+    [("b", ">", 50)],
+])
+
+# Column selection + output
+df = pqfilt.read("data/*.parquet", columns=["a", "b"], output="out.parquet")
+```
+
+## CLI
+
+```bash
+# Basic filter
+pqfilt data/*.parquet -f "vmag < 20" -o filtered.parquet
+
+# AND + OR expression
+pqfilt data/*.parquet -f "(a < 30 & b > 50) | c == 1" -o filtered.parquet
+
+# Multiple -f flags (AND-ed together)
+pqfilt data/*.parquet -f "vmag < 20" -f "dec > 30" -o filtered.parquet
+
+# Column selection
+pqfilt data/*.parquet -f "vmag < 20" --columns vmag,ra,dec -o filtered.parquet
+
+# Membership filter
+pqfilt data/*.parquet -f "desig in 1,2,3" -o filtered.parquet
+```
+
+### Column names with special characters
+
+Columns containing operator characters can be backtick-quoted:
+
+```python
+pqfilt.read("data.parquet", filters="`alpha*360` > 100")
+```
+
+## License
+
+MIT

pqfilt-0.1.0/README.md

@@ -0,0 +1,69 @@
+# pqfilt
+
+Generic Parquet predicate-pushdown filter tool — CLI and Python API.
+
+`pqfilt` wraps `pyarrow.dataset` to let you filter Parquet files **before** they
+are fully read into memory, using row-group-level predicate pushdown.
+
+## Installation
+
+```bash
+pip install pqfilt
+# or
+uv add pqfilt
+```
+
+## Python API
+
+```python
+import pqfilt
+
+# Simple filter
+df = pqfilt.read("data.parquet", filters="vmag < 20")
+
+# AND + OR with expression syntax
+df = pqfilt.read("data.parquet", filters="(a < 30 & b > 50) | c == 1")
+
+# Tuple syntax (flat AND)
+df = pqfilt.read("data.parquet", filters=[("a", "<", 30), ("b", ">", 50)])
+
+# DNF syntax (OR of ANDs)
+df = pqfilt.read("data.parquet", filters=[
+    [("a", "<", 30)],
+    [("b", ">", 50)],
+])
+
+# Column selection + output
+df = pqfilt.read("data/*.parquet", columns=["a", "b"], output="out.parquet")
+```
+
+## CLI
+
+```bash
+# Basic filter
+pqfilt data/*.parquet -f "vmag < 20" -o filtered.parquet
+
+# AND + OR expression
+pqfilt data/*.parquet -f "(a < 30 & b > 50) | c == 1" -o filtered.parquet
+
+# Multiple -f flags (AND-ed together)
+pqfilt data/*.parquet -f "vmag < 20" -f "dec > 30" -o filtered.parquet
+
+# Column selection
+pqfilt data/*.parquet -f "vmag < 20" --columns vmag,ra,dec -o filtered.parquet
+
+# Membership filter
+pqfilt data/*.parquet -f "desig in 1,2,3" -o filtered.parquet
+```
+
+### Column names with special characters
+
+Columns containing operator characters can be backtick-quoted:
+
+```python
+pqfilt.read("data.parquet", filters="`alpha*360` > 100")
+```
+
+## License
+
+MIT

pqfilt-0.1.0/docs/Makefile

@@ -0,0 +1,14 @@
+# Minimal Makefile for Sphinx documentation
+
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)

pqfilt-0.1.0/docs/_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b9d0962ee09329f0f0aaea835b4e83b9
+tags: 645f666f9bcd5a90fca523b33c5a78b7

pqfilt-0.1.0/docs/_build/html/_modules/index.html

@@ -0,0 +1,105 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; pqfilt 0.1.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
+
+  
+      <script src="../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../_static/documentation_options.js?v=01f34227"></script>
+      <script src="../_static/doctools.js?v=fd6eb6e6"></script>
+      <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+          
+          
+          <a href="../index.html" class="icon icon-home">
+            pqfilt
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../usage.html">Usage Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">pqfilt</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="pqfilt/_operators.html">pqfilt._operators</a></li>
+<li><a href="pqfilt/_parser.html">pqfilt._parser</a></li>
+<li><a href="pqfilt/core.html">pqfilt.core</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2026, Yoonsoo P. Bach.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+   
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>