quicklook-package 1.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.4/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch: #optional manual run
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install build tools
+        run: pip install --upgrade build twine
+
+      - name: Clean old builds
+        run: rm -rf dist/*
+
+      - name: Build package
+        run: python -m build --sdist --wheel
+
+      - name: Verify distributions
+        run: twine check dist/*
+
+      - name: Publish to PyPI
+        run: twine upload dist/*
+        env:
+          TWINE_USERNAME: "__token__"
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}

quicklook_package-1.4/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

quicklook_package-1.4/.pre-commit-config.yaml

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

quicklook_package-1.4/MANIFEST.in

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

{quicklook_package-1.2/quicklook_package.egg-info → quicklook_package-1.4}/PKG-INFO

@@ -1,28 +1,38 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: quicklook-package
-Version: 1.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
+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
 
 # 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
+```