eye-patch 1.0.0__tar.gz → 1.1.0__tar.gz

{eye_patch-1.0.0 → eye_patch-1.1.0}/.github/workflows/cd.yml

@@ -25,11 +25,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0
 
-      - uses: hynek/build-and-inspect-python-package@v2
+      - uses: hynek/build-and-inspect-python-package@v3.0.1
 
   publish:
     needs: [dist]

{eye_patch-1.0.0 → eye_patch-1.1.0}/.github/workflows/ci.yml

@@ -22,12 +22,14 @@ jobs:
     name: Format
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v6
+      - uses: actions/setup-python@v7
         with:
-          python-version: "3.x"
+          python-version: |
+            3.11
+            3.x
 
       - uses: astral-sh/setup-uv@v7
 
@@ -42,15 +44,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.12", "3.13", "3.14"]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
         runs-on: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@v6
+      - uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
@@ -66,6 +68,6 @@ jobs:
           --durations=20
 
       - name: Upload coverage report
-        uses: codecov/codecov-action@v6
+        uses: codecov/codecov-action@v7
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

{eye_patch-1.0.0 → eye_patch-1.1.0}/.pre-commit-config.yaml

@@ -36,25 +36,26 @@ repos:
       - id: rst-inline-touching-normal
 
   - repo: https://github.com/rbubley/mirrors-prettier
-    rev: "v3.8.3"
+    rev: "v3.9.4"
     hooks:
       - id: prettier
         types_or: [yaml, markdown, html, css, scss, javascript, json]
         args: [--prose-wrap=always]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.15.12"
+    rev: "v0.15.20"
     hooks:
       - id: ruff-check
         args: ["--fix", "--show-fixes"]
       - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v2.0.0"
+    rev: "v2.1.0"
     hooks:
       - id: mypy
         files: eye_patch|tests
         args: ["--ignore-missing-imports"]
+        language_version: python3.11
         additional_dependencies:
           - numpy
           - capn-crunch
@@ -87,7 +88,7 @@ repos:
         additional_dependencies: ["validate-pyproject-schema-store[all]"]
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: "0.37.2"
+    rev: "0.37.4"
     hooks:
       - id: check-dependabot
       - id: check-github-workflows

{eye_patch-1.0.0 → eye_patch-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: eye-patch
-Version: 1.0.0
+Version: 1.1.0
 Summary: The pirate mask.
 Project-URL: Homepage, https://github.com/flint-crew/eye-patch
 Project-URL: Bug Tracker, https://github.com/flint-crew/eye-patch/issues
@@ -16,7 +16,6 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -34,10 +33,6 @@ Description-Content-Type: text/markdown
 
 # Eye Patch
 
-The pirate mask!
-
-<img width="256" height="256" alt="image" src="https://github.com/user-attachments/assets/2a8e442c-036b-4d78-8370-180c02588c95" />
-
 [![Actions Status][actions-badge]][actions-link]
 [![Documentation Status][rtd-badge]][rtd-link]
 [![PyPI version][pypi-version]][pypi-link]
@@ -58,3 +53,74 @@ The pirate mask!
 [coverage-link]:            https://codecov.io/github/flint-crew/eye-patch
 
 <!-- prettier-ignore-end -->
+
+The pirate mask!
+
+A Python library and CLI tools for creating masks to assist deconvolution of
+interferometric data.
+
+This library was originally the masking module of the
+[Flint](https://github.com/flint-crew/flint) pipeline, but has now been
+separated out for flexible use.
+
+<img width="256" height="256" alt="image" src="https://github.com/user-attachments/assets/2a8e442c-036b-4d78-8370-180c02588c95" />
+
+## Documentation
+
+Full documentation is provided on
+[Read the Docs](https://eye-patch.readthedocs.io/).
+
+## Installation
+
+We publish releases on PyPI:
+
+```bash
+# PyPI release
+pip install eye-patch
+```
+
+You can also install directly from the git repository:
+
+```bash
+# Direct git install (latest push)
+pip install git+https://github.com/flint-crew/eye-patch.git
+```
+
+Or, from a local clone:
+
+```bash
+git clone https://github.com/flint-crew/eye-patch.git
+cd eye-patch
+pip install -e .
+```
+
+We highly recommend using [uv](https://docs.astral.sh/uv/) for speedy
+installations. Reproducible builds can be created using `uv sync`:
+
+```bash
+git clone https://github.com/flint-crew/eye-patch.git
+cd eye-patch
+uv venv
+uv sync
+```
+
+## Contributions
+
+Contributions are welcome! Please do submit a pull request or issue if you spot
+something you would like to address.
+
+The full set of dev tooling can be installed via:
+
+```bash
+git clone https://github.com/flint-crew/eye-patch.git
+cd eye-patch
+pip install -e . --group dev  # --group needs pip 25.1 or newer
+```
+
+Or, using `uv`:
+
+```bash
+git clone https://github.com/flint-crew/eye-patch.git
+cd eye-patch
+uv sync --group dev
+```

eye_patch-1.1.0/README.md

@@ -0,0 +1,93 @@
+# Eye Patch
+
+[![Actions Status][actions-badge]][actions-link]
+[![Documentation Status][rtd-badge]][rtd-link]
+[![PyPI version][pypi-version]][pypi-link]
+[![PyPI platforms][pypi-platforms]][pypi-link]
+[![Coverage][coverage-badge]][coverage-link]
+
+<!-- SPHINX-START -->
+
+<!-- prettier-ignore-start -->
+[actions-badge]:            https://github.com/flint-crew/eye-patch/workflows/CI/badge.svg
+[actions-link]:             https://github.com/flint-crew/eye-patch/actions
+[pypi-link]:                https://pypi.org/project/eye-patch/
+[pypi-platforms]:           https://img.shields.io/pypi/pyversions/eye-patch
+[pypi-version]:             https://img.shields.io/pypi/v/eye-patch
+[rtd-badge]:                https://readthedocs.org/projects/eye-patch/badge/?version=latest
+[rtd-link]:                 https://eye-patch.readthedocs.io/en/latest/?badge=latest
+[coverage-badge]:           https://codecov.io/github/flint-crew/eye-patch/branch/main/graph/badge.svg
+[coverage-link]:            https://codecov.io/github/flint-crew/eye-patch
+
+<!-- prettier-ignore-end -->
+
+The pirate mask!
+
+A Python library and CLI tools for creating masks to assist deconvolution of
+interferometric data.
+
+This library was originally the masking module of the
+[Flint](https://github.com/flint-crew/flint) pipeline, but has now been
+separated out for flexible use.
+
+<img width="256" height="256" alt="image" src="https://github.com/user-attachments/assets/2a8e442c-036b-4d78-8370-180c02588c95" />
+
+## Documentation
+
+Full documentation is provided on
+[Read the Docs](https://eye-patch.readthedocs.io/).
+
+## Installation
+
+We publish releases on PyPI:
+
+```bash
+# PyPI release
+pip install eye-patch
+```
+
+You can also install directly from the git repository:
+
+```bash
+# Direct git install (latest push)
+pip install git+https://github.com/flint-crew/eye-patch.git
+```
+
+Or, from a local clone:
+
+```bash
+git clone https://github.com/flint-crew/eye-patch.git
+cd eye-patch
+pip install -e .
+```
+
+We highly recommend using [uv](https://docs.astral.sh/uv/) for speedy
+installations. Reproducible builds can be created using `uv sync`:
+
+```bash
+git clone https://github.com/flint-crew/eye-patch.git
+cd eye-patch
+uv venv
+uv sync
+```
+
+## Contributions
+
+Contributions are welcome! Please do submit a pull request or issue if you spot
+something you would like to address.
+
+The full set of dev tooling can be installed via:
+
+```bash
+git clone https://github.com/flint-crew/eye-patch.git
+cd eye-patch
+pip install -e . --group dev  # --group needs pip 25.1 or newer
+```
+
+Or, using `uv`:
+
+```bash
+git clone https://github.com/flint-crew/eye-patch.git
+cd eye-patch
+uv sync --group dev
+```

eye_patch-1.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

eye_patch-1.1.0/docs/conf.py

@@ -0,0 +1,73 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+from __future__ import annotations
+
+import eye_patch
+
+project = "eye-patch"
+copyright = "2025, Tim Galvin"
+author = "Tim Galvin"
+version = release = eye_patch.__version__
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx_autodoc_typehints",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
+    "sphinx_copybutton",
+    "autoapi.extension",
+    "sphinxarg.ext",
+]
+
+myst_enable_extensions = [
+    "colon_fence",
+]
+
+autoapi_type = "python"
+autoapi_dirs = ["../eye_patch"]
+autoapi_member_order = "groupwise"
+autoapi_keep_files = False
+autoapi_root = "autoapi"
+autoapi_add_toctree_entry = True
+
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = True
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+
+source_suffix = [".rst", ".md"]
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+# html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]

{eye_patch-1.0.0 → eye_patch-1.1.0}/docs/index.md

@@ -1,15 +1,16 @@
-# eye-patch
-
-```{toctree}
-:maxdepth: 2
-:hidden:
-
-```
+# Eye Patch
 
 ```{include} ../README.md
 :start-after: <!-- SPHINX-START -->
 ```
 
+## Table of contents
+
+```{toctree}
+:maxdepth: 1
+masking.md
+```
+
 ## Indices and tables
 
 - {ref}`genindex`