pymte 1.0.0__tar.gz

pymte-1.0.0/.gitattributes

@@ -0,0 +1,2 @@
+* text=auto eol=lf
+*.csv.gz binary

pymte-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ".[dev]"
+      - run: ruff check .
+      - run: ruff format --check .
+      - run: mypy
+
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check dist/*
+      - run: pip install dist/*.whl
+      - run: python -c "import pymte; print(pymte.__version__)"
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        include:
+          - os: windows-latest
+            python-version: "3.12"
+          - os: macos-latest
+            python-version: "3.12"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install ".[dev,plots]"
+      - run: pytest
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ".[docs]"
+      - run: sphinx-build -W --keep-going -b html docs docs/_build/html

pymte-1.0.0/.github/workflows/oracle.yml

@@ -0,0 +1,30 @@
+name: R oracle
+
+# Regenerates the R reference fixtures with the current R package and runs
+# the parity tests against them. Informational: it never blocks a push.
+
+on:
+  workflow_dispatch:
+
+jobs:
+  oracle:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: "release"
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          packages: |
+            any::ivmte
+            any::lpSolveAPI
+            any::splines2
+            any::jsonlite
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ".[dev]"
+      - run: Rscript tests/fixtures/run_oracle.R tests/fixtures/oracle
+      - run: pytest tests/test_parity.py tests/test_moments.py tests/test_propensity.py tests/test_uspline.py tests/test_datasets.py tests/test_bootstrap.py

pymte-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release
+
+# Builds the package when a version tag is pushed and uploads it to PyPI
+# through trusted publishing (no API token is stored in the repository).
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

pymte-1.0.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+docs/_build/
+docs/generated/
+docs/jupyter_execute/
+.ipynb_checkpoints/

pymte-1.0.0/.readthedocs.yaml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

pymte-1.0.0/CITATION.cff

@@ -0,0 +1,53 @@
+cff-version: 1.2.0
+message: "If you use this package, please cite the methodological papers listed under references as well as the software."
+title: "pymte: instrumental variables and marginal treatment effects in Python"
+type: software
+authors:
+  - family-names: Ronczewski
+    given-names: Alex
+license: GPL-3.0-or-later
+repository-code: "https://github.com/alexr951/pymte"
+abstract: >-
+  A Python port of the R package ivmte by Joshua Shea and Alexander
+  Torgovitsky, implementing the marginal treatment effect framework of
+  Mogstad, Santos and Torgovitsky (2018).
+references:
+  - type: article
+    title: "Using Instrumental Variables for Inference About Policy Relevant Treatment Parameters"
+    authors:
+      - family-names: Mogstad
+        given-names: Magne
+      - family-names: Santos
+        given-names: Andres
+      - family-names: Torgovitsky
+        given-names: Alexander
+    journal: Econometrica
+    volume: 86
+    issue: 5
+    start: 1589
+    end: 1619
+    year: 2018
+    doi: 10.3982/ECTA15463
+  - type: article
+    title: "ivmte: An R Package for Extrapolating Instrumental Variable Estimates Away From Compliers"
+    authors:
+      - family-names: Shea
+        given-names: Joshua
+      - family-names: Torgovitsky
+        given-names: Alexander
+    journal: Observational Studies
+    volume: 9
+    issue: 2
+    start: 1
+    end: 42
+    year: 2023
+    doi: 10.1353/obs.2023.0016
+  - type: software
+    title: "ivmte: Instrumental Variables: Extrapolation by Marginal Treatment Effects"
+    authors:
+      - family-names: Shea
+        given-names: Joshua
+      - family-names: Torgovitsky
+        given-names: Alexander
+    repository-code: "https://github.com/jkcshea/ivmte"
+    license: GPL-3.0