First steps (#1)

mccalluc · web-flow · commit cadaa882d4d8 · 2025-10-09T16:15:02.000-04:00
* stub repo

* copy over scripts and tweak; install deps

* dev configuration: tests pass

* CI
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,11 @@
+[run]
+# All files under source are checked, even if not otherwise referenced.
+source = .
+
+# More strict: Check transitions between lines, not just individual lines.
+branch = True
+
+[report]
+show_missing = True
+skip_covered = True
+fail_under = 100
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,12 @@
+[flake8]
+exclude = .git,.venv,.venv-*,__pycache__
+
+# Config recommended by black:
+# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#bugbear
+max-line-length = 80
+extend-select = B950
+extend-ignore = E203,E501,E701
+
+per-file-ignores =
+    # Ignore undefined names in templates.
+    **/no-tests/*.py:F821,F401,E302
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
@@ -0,0 +1,8 @@
+---
+name: Bug
+about: Something is broken.
+type: 'Bug'
+
+---
+
+Please provide relevant environment details, a minimal reproducer for the bug, and the expected behavior.
diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md
@@ -0,0 +1,8 @@
+---
+name: Feature
+about: Something is missing.
+type: 'Feature'
+
+---
+
+Besides simply describing a new feature, it may help to include who would use this feature, and what problem they're trying to solve.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,6 @@
+---
+name: Question
+about: Something is unclear.
+type: 'Task'
+
+---
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,40 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        python-version:
+          - '3.10'
+          - '3.13'
+        requirements-file:
+          - 'requirements-dev.txt' # pinned, for predictability
+          - 'requirements-dev.in' # un-pinned, so we catch problems early
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install flit
+        run: pip install flit
+
+      - name: Install package
+        run: flit install
+
+      - name: Install dev dependencies
+        run: pip install -r ${{ matrix.requirements-file }}
+
+      - name: Test
+        run: scripts/ci.sh
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+# MacOS
+.DS_Store
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[codz]
@@ -182,9 +185,9 @@ cython_debug/
 .abstra/
 
 # Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  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, 
+#  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/
 
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+  # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 24.8.0
+    hooks:
+      - id: black
+        # It is recommended to specify the latest version of Python
+        # supported by your project here, or alternatively use
+        # pre-commit's default_language_version, see
+        # https://pre-commit.com/#top_level-default_language_version
+        language_version: python3.11
+  - repo: https://github.com/pycqa/isort
+    rev: 6.0.1
+    hooks:
+      - id: isort
+        name: isort (python)
diff --git a/.pytest.ini b/.pytest.ini
@@ -0,0 +1,10 @@
+[pytest]
+
+filterwarnings =
+	# Treat warnings as errors,
+	error
+
+addopts = --doctest-glob '*.md' --doctest-modules
+
+# If an xfail starts passing unexpectedly, that should count as a failure:
+xfail_strict=true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1 @@
+# CHANGELOG
diff --git a/README.md b/README.md
@@ -1,2 +1,55 @@
 # polars-to-ibis
+
+[![pypi](https://img.shields.io/pypi/v/polars_to_ibis)](https://pypi.org/project/polars_to_ibis/)
+
 Convert Polars expressions to Ibis expressions
+
+## Usage
+
+TODO
+
+## Contributions
+
+There are several ways to contribute. First, if you find `polars_to_ibis` useful, please [let us know](mailto:info@opendp.org) and we'll spend more time on this project. If `polars_to_ibis` doesn't work for you, we also want to know that! Please [file an issue](https://github.com/opendp/polars-to-ibis/issues/new/choose) and we'll look into it.
+
+We also welcome PRs, but if you have an idea for a new feature, it may be helpful to get in touch before you begin, to make sure your idea is in line with our vision.
+
+## Development
+
+### Getting Started
+
+`polars_to_ibis` supports multiple Python versions, but for the fewest surprises during development, it makes sense to use the oldest supported version in a virtual environment. On MacOS:
+```shell
+$ git clone https://github.com/opendp/polars-to-ibis.git
+$ cd polars-to-ibis
+$ brew install python@3.10
+$ python3.10 -m venv .venv
+$ source .venv/bin/activate
+$ pip install -r requirements-dev.txt
+$ pre-commit install
+$ pip install --editable .
+```
+
+### Testing
+
+Tests should pass, and code coverage should be complete (except blocks we explicitly ignore):
+```shell
+$ scripts/ci.sh
+```
+
+### Release
+
+- Make sure you're up to date, and have the git-ignored credentials file `.pypirc`.
+- Make one last feature branch with the new version number in the name:
+  - Run `scripts/changelog.py` to update the `CHANGELOG.md`.
+  - Review the updates and pull a couple highlights to the top.
+  - Bump `polars_to_ibis/VERSION`, and add the new number at the top of the `CHANGELOG.md`.
+  - Commit your changes, make a PR, and merge this branch to main.
+- Update `main` with the latest changes: `git checkout main; git pull`
+- Publish: `flit publish --pypirc .pypirc`
+
+### Conventions
+
+Branch names should be of the form `NNNN-short-description`, where `NNNN` is the issue number being addressed.
+
+Add developer-only dependencies in `requirements-dev.in`; Add other dependencies in `requirements.in`. After an edit to either file run `scripts/requirements.py` to install the new dependency locally and update `pyproject.toml`.
diff --git a/polars_to_ibis/VERSION b/polars_to_ibis/VERSION
@@ -0,0 +1 @@
+0.0.1
diff --git a/polars_to_ibis/__init__.py b/polars_to_ibis/__init__.py
@@ -0,0 +1,5 @@
+"""Convert Polars expressions to Ibis expressions"""
+
+from pathlib import Path
+
+__version__ = (Path(__file__).parent / "VERSION").read_text().strip()
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,25 @@
+[build-system]
+requires = ["flit_core >=3.11,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "polars_to_ibis"
+authors = [{name = "Chuck McCallum", email = "info@opendp.org"}]
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+dynamic = ["version", "description"]
+dependencies = [
+    "ibis",
+    "polars",
+]
+
+[project.urls]
+Home = "https://github.com/opendp/polars-to-ibis"
+
+[project.optional-dependencies]
+app = [
+    "ibis==3.3.0",
+    "polars-runtime-32==1.34.0",
+    "polars==1.34.0",
+]
diff --git a/requirements-dev.in b/requirements-dev.in
@@ -0,0 +1,20 @@
+# After making changes here, run scripts/requirements.py.
+
+# Developer tools:
+pip-tools
+flit
+flake8
+flake8-bugbear
+pre-commit
+tomlkit
+isort
+black
+
+# Testing:
+pytest
+pyright
+pytest-cov
+pytest-xdist
+
+# App dependencies:
+-r requirements.in
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -0,0 +1,126 @@
+#
+# This file is autogenerated by pip-compile with Python 3.13
+# by the following command:
+#
+#    pip-compile requirements-dev.in
+#
+attrs==25.4.0
+    # via flake8-bugbear
+black==25.9.0
+    # via -r requirements-dev.in
+build==1.3.0
+    # via pip-tools
+certifi==2025.10.5
+    # via requests
+cfgv==3.4.0
+    # via pre-commit
+charset-normalizer==3.4.3
+    # via requests
+click==8.3.0
+    # via
+    #   black
+    #   pip-tools
+coverage[toml]==7.10.7
+    # via pytest-cov
+distlib==0.4.0
+    # via virtualenv
+docutils==0.22.2
+    # via flit
+execnet==2.1.1
+    # via pytest-xdist
+filelock==3.20.0
+    # via virtualenv
+flake8==7.3.0
+    # via
+    #   -r requirements-dev.in
+    #   flake8-bugbear
+flake8-bugbear==24.12.12
+    # via -r requirements-dev.in
+flit==3.12.0
+    # via -r requirements-dev.in
+flit-core==3.12.0
+    # via flit
+ibis==3.3.0
+    # via -r requirements.in
+identify==2.6.15
+    # via pre-commit
+idna==3.10
+    # via requests
+iniconfig==2.1.0
+    # via pytest
+isort==6.1.0
+    # via -r requirements-dev.in
+mccabe==0.7.0
+    # via flake8
+mypy-extensions==1.1.0
+    # via black
+nodeenv==1.9.1
+    # via
+    #   pre-commit
+    #   pyright
+packaging==25.0
+    # via
+    #   black
+    #   build
+    #   pytest
+pathspec==0.12.1
+    # via black
+pip-tools==7.5.1
+    # via -r requirements-dev.in
+platformdirs==4.5.0
+    # via
+    #   black
+    #   virtualenv
+pluggy==1.6.0
+    # via
+    #   pytest
+    #   pytest-cov
+polars==1.34.0
+    # via -r requirements.in
+polars-runtime-32==1.34.0
+    # via polars
+pre-commit==4.3.0
+    # via -r requirements-dev.in
+pycodestyle==2.14.0
+    # via flake8
+pyflakes==3.4.0
+    # via flake8
+pygments==2.19.2
+    # via pytest
+pyproject-hooks==1.2.0
+    # via
+    #   build
+    #   pip-tools
+pyright==1.1.406
+    # via -r requirements-dev.in
+pytest==8.4.2
+    # via
+    #   -r requirements-dev.in
+    #   pytest-cov
+    #   pytest-xdist
+pytest-cov==7.0.0
+    # via -r requirements-dev.in
+pytest-xdist==3.8.0
+    # via -r requirements-dev.in
+pytokens==0.1.10
+    # via black
+pyyaml==6.0.3
+    # via pre-commit
+requests==2.32.5
+    # via flit
+tomli-w==1.2.0
+    # via flit
+tomlkit==0.13.3
+    # via -r requirements-dev.in
+typing-extensions==4.15.0
+    # via pyright
+urllib3==2.5.0
+    # via requests
+virtualenv==20.34.0
+    # via pre-commit
+wheel==0.45.1
+    # via pip-tools
+
+# The following packages are considered to be unsafe in a requirements file:
+# pip
+# setuptools
diff --git a/requirements.in b/requirements.in
@@ -0,0 +1,4 @@
+# After making changes here, run scripts/requirements.py.
+
+polars
+ibis
diff --git a/requirements.txt b/requirements.txt
diff --git a/scripts/changelog.py b/scripts/changelog.py
diff --git a/scripts/ci.sh b/scripts/ci.sh
diff --git a/scripts/requirements.py b/scripts/requirements.py
diff --git a/test_misc.py b/test_misc.py
diff --git a/tests/test_todo.py b/tests/test_todo.py
