quicklook-package 1.3.2__tar.gz → 1.4__tar.gz

quicklook_package-1.4/.github/workflows/build-and-test.yml

@@ -0,0 +1,73 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-13]
+        #python-version: ["3.8", "3.9", "3.10", "3.11"]
+        #tox-env: ["py38", "py39", "py310", "py311"]  # without dot
+        python-version: ["3.10"]
+        tox-env: ["py10"] # update also `envlist` in tox.ini
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Cache pip packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Cache tox virtualenvs
+        uses: actions/cache@v3
+        with:
+          path: .tox
+          key: ${{ runner.os }}-tox-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-tox-
+
+      - name: Cache Lightkurve data
+        uses: actions/cache@v3
+        with:
+          path: ~/.lightkurve/cache/mastDownload
+          key: ${{ runner.os }}-lightkurve-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-lightkurve-
+
+      - name: Remove corrupted FITS (if any)
+        run: |
+          find ~/.lightkurve/cache/mastDownload -type f -name "*.fits" -size -1M -delete || true
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev,notebooks]"
+
+      - name: Run regular tests
+        run: tox -e ${{ matrix.tox-env }}
+
+      #- name: Run notebook tests
+      #  run: tox -e notebook
+      #- name: Run linting
+      #  run: tox -e lint
+      #- name: Check code formatting
+      #  run: tox -e format
+      #- name: Run type checks
+      #  run: tox -e type

{quicklook_package-1.3.2 → quicklook_package-1.4}/.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Publish to PyPI
 on:
   workflow_dispatch: #optional manual run
   release:
-    types: [published] # run only when published after creating a tag (e.g. v.1.4)
+    types: [published]
 
 jobs:
   publish:
@@ -19,11 +19,16 @@ jobs:
           python-version: "3.10"
 
       - name: Install build tools
-        run: |
-          pip install build twine
+        run: pip install --upgrade build twine
+
+      - name: Clean old builds
+        run: rm -rf dist/*
 
       - name: Build package
-        run: python -m build
+        run: python -m build --sdist --wheel
+
+      - name: Verify distributions
+        run: twine check dist/*
 
       - name: Publish to PyPI
         run: twine upload dist/*

{quicklook_package-1.3.2 → quicklook_package-1.4}/.pre-commit-config.yaml

@@ -1,16 +1,16 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
     -   id: check-yaml
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/psf/black
-    rev: 25.1.0
+    rev: 25.9.0
     hooks:
     - id: black
       language_version: python3.10
--   repo: https://github.com/pycqa/flake8
-    rev: 7.2.0
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.13.1
     hooks:
-    - id: flake8
+        - id: ruff

quicklook_package-1.4/MANIFEST.in

@@ -0,0 +1 @@
+include quicklook/data/*.csv

{quicklook_package-1.3.2 → quicklook_package-1.4}/PKG-INFO

@@ -1,32 +1,38 @@
 Metadata-Version: 2.4
 Name: quicklook-package
-Version: 1.3.2
-Summary: Quicklook lightcurve plot generator
-Home-page: https://github.com/jpdeleon/quicklook
+Version: 1.4
 Author-email: jpdeleon <jpdeleon.bsap@gmail.com>
 Project-URL: Homepage, https://github.com/jpdeleon/quicklook
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Topic :: Scientific/Engineering :: Astronomy
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pre-commit==3.4.0
 Requires-Dist: matplotlib
 Requires-Dist: lightkurve==2.5
 Requires-Dist: numpy==1.23
 Requires-Dist: transitleastsquares==1.32
 Requires-Dist: wotan==1.10
-Requires-Dist: aesthetic==0.6
 Requires-Dist: flammkuchen==1.0.3
 Requires-Dist: reproject==0.12.0
 Requires-Dist: astroplan==0.9
 Requires-Dist: loguru
 Requires-Dist: importlib_resources>=5.0.0
-Dynamic: home-page
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-benchmark; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Provides-Extra: notebooks
+Requires-Dist: ipykernel; extra == "notebooks"
+Requires-Dist: jupyter; extra == "notebooks"
+Requires-Dist: nbconvert; extra == "notebooks"
 Dynamic: license-file
-Dynamic: summary
 
 # QuickLook
 `quicklook` is a Python program that runs a simple pipeline to search for transit signal in TESS (and Kepler soon) light curves. This program can be run in a jupyter notebook or from the terminal using the `ql` script.

quicklook_package-1.4/README_DEV.md

@@ -0,0 +1,59 @@
+## Development & Testing
+
+- **Install dev tools**:
+
+```bash
+pip install -e ".[dev,notebooks]"
+```
+
+- **Initialize pre-commit**:
+```bash
+pre-commit install
+```
+
+- **Run tests**:
+
+```bash
+tox
+```
+
+- **Run only notebooks tests**:
+
+```bash
+pytest -v -m notebook
+```
+
+- **Run linting, typing, and formatting**:
+
+```bash
+tox -e lint
+tox -e type
+tox -e black
+```
+
+- **Benchmark performance** (locally, not in CI):
+
+```bash
+pytest --benchmark-only
+```
+
+
+```python
+import os
+import pytest
+import pytest_benchmark
+
+@pytest.mark.skipif(os.getenv("CI") == "true", reason="Skip performance tests in CI")
+@pytest.mark.benchmark
+def test_tql_runtime(benchmark, planet_inputs):
+    def run_ql():
+        ql = TessQuickLook(**planet_inputs)
+        fig = ql.plot_tql()
+    benchmark(run_ql)
+```
+
+- **Re-install tox**:
+
+```bash
+tox -r
+```

quicklook_package-1.4/pyproject.toml

@@ -0,0 +1,92 @@
+[build-system]
+requires = [
+    "setuptools>=61.0",
+    "setuptools_scm",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+fallback_version = "0.0.0"
+version_scheme = "guess-next-dev"
+local_scheme = "no-local-version"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["quicklook*"]
+exclude = ["app*", "static*", "notebook*", "tests*"]
+
+[tool.setuptools.package-data]
+"quicklook" = ["data/*.csv"]
+
+[project]
+name = "quicklook-package"
+dynamic = ["version"]
+authors = [{name = "jpdeleon", email = "jpdeleon.bsap@gmail.com"}]
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: POSIX :: Linux",
+    "Topic :: Scientific/Engineering :: Astronomy",
+]
+dependencies = [
+    "matplotlib",
+    "lightkurve==2.5",
+    "numpy==1.23",
+    "transitleastsquares==1.32",
+    "wotan==1.10",
+    "flammkuchen==1.0.3",
+    "reproject==0.12.0",
+    "astroplan==0.9",
+    "loguru",
+    "importlib_resources>=5.0.0"
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",           # run tests
+    "pytest-benchmark", # measure performance
+    "pytest-xdist",
+    "black",            # enforce formatting
+    "mypy",             # static type checking
+    "pre-commit",       # hook management
+    "tox",              # multi-env testing
+    "ruff",             # fast linting
+    #"flake8>=6.0"       # legacy linting
+]
+
+# --- converter ---
+notebooks = [
+    "ipykernel",
+    "jupyter",
+    "nbconvert"
+]
+
+[project.urls]
+Homepage = "https://github.com/jpdeleon/quicklook"
+
+# --- formatter ---
+[tool.black]
+line-length = 100
+include = '\.pyi?$'
+exclude = '/(\.git|\.hg|\.mypy_cache|\.tox|\.venv|_build|buck-out|build|dist)/'
+
+# --- linter ---
+[tool.ruff]
+line-length = 100
+select = ["B", "C", "E", "F", "W", "B9"]
+
+[tool.ruff.lint]
+ignore = [
+  "E203",
+  "E266",
+  "E501",
+  "F403",
+  "F401",
+  "C901",
+  "B904",  #exceptions
+  "B006", #Do not use mutable data structures for argument defaults
+  "B028", #No explicit `stacklevel` keyword argument found; in gls.py
+  "C408",  #Unnecessary `dict()` call; in gls.py
+]

quicklook_package-1.4/quicklook/compat.py

@@ -0,0 +1,42 @@
+"""
+Compatibility module for different Python versions.
+"""
+
+import sys
+from pathlib import Path
+
+
+def get_data_path(package_name: str) -> Path:
+    """
+    Get the path to the data directory for a package, compatible across Python versions.
+    """
+    # Python ≥3.9
+    if sys.version_info >= (3, 9):
+        try:
+            from importlib.resources import files, as_file
+
+            data_path = files(package_name).joinpath("data")
+            # as_file ensures we get a real filesystem path
+            return Path(as_file(data_path).__enter__())
+        except Exception:
+            pass
+
+    # Backport for older Python
+    try:
+        from importlib_resources import files, as_file
+
+        data_path = files(package_name).joinpath("data")
+        return Path(as_file(data_path).__enter__())
+    except Exception:
+        pass
+
+    # Fallback using __file__
+    import importlib.util
+    import os
+
+    spec = importlib.util.find_spec(package_name)
+    if spec and spec.origin:
+        return Path(spec.origin).parent.joinpath("data")
+
+    # Last resort
+    return Path(sys.modules[package_name].__file__).parent.joinpath("data")