Base functionality, sphinx and PyPi config

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+# Exclude all __init__.py files
+exclude = __init__.py, ./tests/**/**

.github/workflows/lint-and-test.yml

@@ -0,0 +1,36 @@
+name: Lint with flake8 and test with PyTest
+
+on: [pull_request]
+
+jobs:
+  flake8-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install testing dependencies
+        run: |
+          pip install flake8 pep8-naming pytest pytest-cov
+
+      - name: Install package dependencies
+        run: |
+          pip install -e .
+
+      - name: Run flake8
+        run: |
+          flake8 EEGPhasePy
+
+      - name: Run PyTest
+        run: |
+          pytest --cov --cov-branch --cov-report=xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1 +1,6 @@
-phase-eeg
+__pycache__
+venv
+dist
+EEGPhasePy.egg-info
+eegphasepy.egg-info
+tests/test_data/**

.readthedocs.yaml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

EEGPhasePy/estimators/__init__.py

@@ -1 +1,3 @@
-from .etp import ETP
+from .etp import ETP
+from .estimator import Estimator
+from .phastimate import PHASTIMATE