Merge branch 'main' into gallery

Author: juanitorduz

.gitignore

@@ -16,3 +16,4 @@ docs/jupyter_execute/
 docs/source/api/generated/
 docs/source/_static/thumbnails/
 # Note: thumbnails are generated during build (see .readthedocs.yaml)
+.cursor/

.pre-commit-config.yaml

@@ -21,11 +21,16 @@ repos:
       - id: end-of-file-fixer
         exclude_types: [svg]
       - id: check-yaml
+      - id: check-toml
+      - id: check-json
       - id: check-added-large-files
-        exclude: &exclude_pattern 'iv_weak_instruments.ipynb'
+        exclude: &exclude_pattern '(iv_weak_instruments|its_lift_test)\.ipynb'
         args: ["--maxkb=1500"]
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: mixed-line-ending
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.4
+    rev: v0.14.7
     hooks:
       # Run the linter
       - id: ruff
@@ -49,9 +54,13 @@ repos:
           # Support pyproject.toml configuration
           - tomli
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.18.2
+    rev: v1.19.0
     hooks:
       - id: mypy
         args: [--ignore-missing-imports]
         files: ^causalpy/
         additional_dependencies: [numpy>=1.20, pandas-stubs]
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.24.1
+    hooks:
+      - id: validate-pyproject

AGENTS.md

@@ -59,6 +59,15 @@ When creating a new example notebook:
 - **Custom exceptions**: Use project-specific exceptions from `causalpy.custom_exceptions`: `FormulaException`, `DataException`, `BadIndexException`
 - **File organization**: Experiments in `causalpy/experiments/`, PyMC models in `causalpy/pymc_models.py`, scikit-learn models in `causalpy/skl_models.py`
 
+## Code quality checks
+
+- **Before committing**: Always run `pre-commit run --all-files` to ensure all checks pass (linting, formatting, type checking)
+- **Quick check**: Run `ruff check causalpy/` for fast linting feedback during development
+- **Auto-fix**: Run `ruff check --fix causalpy/` to automatically fix many linting issues
+- **Format**: Run `ruff format causalpy/` to format code according to project standards
+- **Linting rules**: Project uses strict linting (F, B, UP, C4, SIM, I) to catch bugs and enforce modern Python patterns
+- **Note**: Documentation notebooks in `docs/` are excluded from strict linting rules
+
 ## Type Checking
 
 - **Tool**: MyPy

causalpy/data/PISA18sampleScale.csv

@@ -98,4 +98,4 @@ PV1READ,Female,ESCS,METASUM,PERFEED,JOYREAD,MASTGOAL,ADAPTIVITY,TEACHINT,SCREADD
 1.382758437,0,1.112755087,1.024329216,-1.363017023,0.546695917,-0.300835494,0.488206717,0.990856172,0.19103636,-0.063690149
 -0.180166117,0,-0.903784153,1.416120964,-0.789077206,0.3589234,-2.209705037,-1.353064842,-0.668887592,0.689393741,-0.929939088
 -0.138452609,0,-1.523831485,-0.171666648,0.021680557,-0.050770988,1.521829065,-0.8111262,-0.039406676,0.66554889,-0.851380406
-0.907727459,1,0.115773982,1.024329216,1.478217432,0.461175761,-0.873789642,0.080450276,-0.668887592,-0.265544842,-0.063690149
+0.907727459,1,0.115773982,1.024329216,1.478217432,0.461175761,-0.873789642,0.080450276,-0.668887592,-0.265544842,-0.063690149

causalpy/experiments/__init__.py

@@ -11,4 +11,24 @@
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
-"""Quasi-experimental designs for causal inference."""
+"""CausalPy experiment module"""
+
+from .diff_in_diff import DifferenceInDifferences
+from .instrumental_variable import InstrumentalVariable
+from .interrupted_time_series import InterruptedTimeSeries
+from .inverse_propensity_weighting import InversePropensityWeighting
+from .prepostnegd import PrePostNEGD
+from .regression_discontinuity import RegressionDiscontinuity
+from .regression_kink import RegressionKink
+from .synthetic_control import SyntheticControl
+
+__all__ = [
+    "DifferenceInDifferences",
+    "InstrumentalVariable",
+    "InversePropensityWeighting",
+    "PrePostNEGD",
+    "RegressionDiscontinuity",
+    "RegressionKink",
+    "SyntheticControl",
+    "InterruptedTimeSeries",
+]