starbash 0.1.1__tar.gz → 0.1.4__tar.gz

starbash-0.1.4/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: starbash
+Version: 0.1.4
+Summary: A tool for automating/standardizing/sharing astrophotography workflows.
+License-File: LICENSE
+Author: Kevin Hester
+Author-email: kevinh@geeksville.com
+Requires-Python: >=3.12,<3.15
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: astropy (>=7.1.1,<8.0.0)
+Requires-Dist: multidict (>=6.7.0,<7.0.0)
+Requires-Dist: platformdirs (>=4.5.0,<5.0.0)
+Requires-Dist: restrictedpython (>=8.1,<9.0)
+Requires-Dist: rich (>=14.2.0,<15.0.0)
+Requires-Dist: sentry-sdk (>=2.42.1,<3.0.0)
+Requires-Dist: tomlkit (>=0.13.3,<0.14.0)
+Requires-Dist: typer (>=0.20.0,<0.21.0)
+Description-Content-Type: text/markdown
+
+# Starbash
+
+[![PyPI - Version](https://img.shields.io/pypi/v/starbash)](https://pypi.org/project/starbash/)
+[![GitHub branch check runs](https://img.shields.io/github/check-runs/geeksville/starbash/main)](https://github.com/geeksville/starbash/actions)
+[![codecov](https://codecov.io/github/geeksville/starbash/graph/badge.svg?token=47RE10I7O1)](https://codecov.io/github/geeksville/starbash)
+
+ ![app icon](https://raw.githubusercontent.com/geeksville/starbash/refs/heads/main/img/icon.png "Starbash: Astrophotography workflows simplified")
+
+A tool for automating/standardizing/sharing astrophotography workflows.
+
+# Current status
+
+Not quite ready 😊.  But making good progress.
+
+See the current [TODO](TODO.md) file for work items.  I'll be looking for pre-alpha testers/feedback soon.
+
+## Current features
+
+* Automatically recognizes and auto-parses the default NINA, Asiair and Seestar raw file repos (adding support for other layouts is easy)
+* Multisession support by default (including automatic selection of correct flats, biases and dark frames)
+* 'Repos' can contain raw files, generated masters, preprocessed files, or recipes.
+
+## Features coming soon
+
+* Automatically performs **complete** preprocessing on OSC (broadband, narrowband or dual Duo filter), Mono (LRGB, SHO) data.  i.e. give you 'seestar level' auto-preprocessing, so you only need to do the (optional) custom post-processing.
+* Generates a per target report/config file which can be customized if the detected defaults or preprocessing are not what you want
+* 'Recipes' provide repeatable/human-readable/sharable descriptions of all processing steps
+* Repos can be on the local disk or shared via HTTPS/github/etc.  This is particularly useful for recipe repos
+* Uses Siril and Graxpert for its pre-processing operations (support for Pixinsight based recipes will probably be coming at some point...)
+* The target report can be used to auto generate a human friendly 'postable/sharable' report about that image
+* Target reports are sharable so that you can request comments by others and others can rerender with different settings
+
+## Installing
+
+Currently the easiest way to install this command-line based tool is to install is via [pipx](https://pipx.pypa.io/stable/).  If you don't already have pipx and you have python installed, you can auto install it by running "pip install --user pipx."  If you don't have python installed see the pipx link for pipx installers for any OS.
+
+Once pipx is installed just run:
+
+```
+pipx install starbash
+  installed package starbash 0.1.3, installed using Python 3.12.3
+  These apps are now globally available
+    - sb
+    - starbash
+done! ✨ 🌟 ✨
+```
+
+FIXME - add getting started instructions (possibly with a screenshare video)
+
+## Supported commands
+
+### Repository Management
+- `sb repo [--verbose]` - List installed repos (use `-v` for details)
+- `sb repo add <filepath|URL>` - Add a repository
+- `sb repo remove <REPONUM>` - Remove the indicated repo from the repo list
+- `sb repo reindex [--force] [REPONUM]` - Reindex the specified repo (or all repos if none specified)
+
+### User Preferences
+- `sb user name "Your Name"` - Set name for attribution in generated images
+- `sb user email "foo@example.com"` - Set email for attribution in generated images
+- `sb user analytics <on|off>` - Turn analytics collection on/off
+- `sb user reinit` - Configure starbash via a brief guided process
+
+### Selection & Filtering
+- `sb select` - Show information about the current selection
+- `sb select list` - List sessions (filtered based on the current selection)
+- `sb select any` - Remove all filters (select everything)
+- `sb select target <TARGETNAME>` - Limit selection to the named target
+- `sb select telescope <TELESCOPENAME>` - Limit selection to the named telescope
+- `sb select date <after|before|between> <DATE> [DATE]` - Limit to sessions in the specified date range
+- `sb select export SESSIONNUM DESTDIR` - Export the images for indicated session number into the specified directory (or current directory if not specified).  If possible symbolic links are used, if not the files are copied.
+
+## Not yet supported commands
+
+### Setup & Configuration
+- `sb info` - Show user preferences location and other app info
+- `sb info target` - List targets (filtered based on the current selection)
+- `sb info telescope` - List instruments (filtered based on the current selection)
+- `sb info filter` - List all filters found in current selection
+
+### Export & Processing
+- `sb process siril` - Generate Siril directory tree and run Siril GUI
+- `sb process auto` - Automatic processing
+- `sb process masters` - Generate master flats, darks, and biases from available raw frames
+
+## Supported tools (now)
+
+* Siril
+* Graxpert
+* Python (you can add python code to recipes if necessary)
+
+## Supported tools (future?)
+
+* Pixinsight?
+* Autostakkert?
+
+## Developing
+
+We try to make this project useful and friendly.  If you find problems please file a github issue.
+We accept pull-requests and enjoy discussing possible new development directions via github issues.  If you might want to work on this, just describe what your interests are and we can talk about how to get it merged.
+
+Project members can access crash reports [here](https://geeksville.sentry.io/insights/projects/starbash/?project=4510264204132352).

starbash-0.1.4/README.md

@@ -0,0 +1,102 @@
+# Starbash
+
+[![PyPI - Version](https://img.shields.io/pypi/v/starbash)](https://pypi.org/project/starbash/)
+[![GitHub branch check runs](https://img.shields.io/github/check-runs/geeksville/starbash/main)](https://github.com/geeksville/starbash/actions)
+[![codecov](https://codecov.io/github/geeksville/starbash/graph/badge.svg?token=47RE10I7O1)](https://codecov.io/github/geeksville/starbash)
+
+ ![app icon](https://raw.githubusercontent.com/geeksville/starbash/refs/heads/main/img/icon.png "Starbash: Astrophotography workflows simplified")
+
+A tool for automating/standardizing/sharing astrophotography workflows.
+
+# Current status
+
+Not quite ready 😊.  But making good progress.
+
+See the current [TODO](TODO.md) file for work items.  I'll be looking for pre-alpha testers/feedback soon.
+
+## Current features
+
+* Automatically recognizes and auto-parses the default NINA, Asiair and Seestar raw file repos (adding support for other layouts is easy)
+* Multisession support by default (including automatic selection of correct flats, biases and dark frames)
+* 'Repos' can contain raw files, generated masters, preprocessed files, or recipes.
+
+## Features coming soon
+
+* Automatically performs **complete** preprocessing on OSC (broadband, narrowband or dual Duo filter), Mono (LRGB, SHO) data.  i.e. give you 'seestar level' auto-preprocessing, so you only need to do the (optional) custom post-processing.
+* Generates a per target report/config file which can be customized if the detected defaults or preprocessing are not what you want
+* 'Recipes' provide repeatable/human-readable/sharable descriptions of all processing steps
+* Repos can be on the local disk or shared via HTTPS/github/etc.  This is particularly useful for recipe repos
+* Uses Siril and Graxpert for its pre-processing operations (support for Pixinsight based recipes will probably be coming at some point...)
+* The target report can be used to auto generate a human friendly 'postable/sharable' report about that image
+* Target reports are sharable so that you can request comments by others and others can rerender with different settings
+
+## Installing
+
+Currently the easiest way to install this command-line based tool is to install is via [pipx](https://pipx.pypa.io/stable/).  If you don't already have pipx and you have python installed, you can auto install it by running "pip install --user pipx."  If you don't have python installed see the pipx link for pipx installers for any OS.
+
+Once pipx is installed just run:
+
+```
+pipx install starbash
+  installed package starbash 0.1.3, installed using Python 3.12.3
+  These apps are now globally available
+    - sb
+    - starbash
+done! ✨ 🌟 ✨
+```
+
+FIXME - add getting started instructions (possibly with a screenshare video)
+
+## Supported commands
+
+### Repository Management
+- `sb repo [--verbose]` - List installed repos (use `-v` for details)
+- `sb repo add <filepath|URL>` - Add a repository
+- `sb repo remove <REPONUM>` - Remove the indicated repo from the repo list
+- `sb repo reindex [--force] [REPONUM]` - Reindex the specified repo (or all repos if none specified)
+
+### User Preferences
+- `sb user name "Your Name"` - Set name for attribution in generated images
+- `sb user email "foo@example.com"` - Set email for attribution in generated images
+- `sb user analytics <on|off>` - Turn analytics collection on/off
+- `sb user reinit` - Configure starbash via a brief guided process
+
+### Selection & Filtering
+- `sb select` - Show information about the current selection
+- `sb select list` - List sessions (filtered based on the current selection)
+- `sb select any` - Remove all filters (select everything)
+- `sb select target <TARGETNAME>` - Limit selection to the named target
+- `sb select telescope <TELESCOPENAME>` - Limit selection to the named telescope
+- `sb select date <after|before|between> <DATE> [DATE]` - Limit to sessions in the specified date range
+- `sb select export SESSIONNUM DESTDIR` - Export the images for indicated session number into the specified directory (or current directory if not specified).  If possible symbolic links are used, if not the files are copied.
+
+## Not yet supported commands
+
+### Setup & Configuration
+- `sb info` - Show user preferences location and other app info
+- `sb info target` - List targets (filtered based on the current selection)
+- `sb info telescope` - List instruments (filtered based on the current selection)
+- `sb info filter` - List all filters found in current selection
+
+### Export & Processing
+- `sb process siril` - Generate Siril directory tree and run Siril GUI
+- `sb process auto` - Automatic processing
+- `sb process masters` - Generate master flats, darks, and biases from available raw frames
+
+## Supported tools (now)
+
+* Siril
+* Graxpert
+* Python (you can add python code to recipes if necessary)
+
+## Supported tools (future?)
+
+* Pixinsight?
+* Autostakkert?
+
+## Developing
+
+We try to make this project useful and friendly.  If you find problems please file a github issue.
+We accept pull-requests and enjoy discussing possible new development directions via github issues.  If you might want to work on this, just describe what your interests are and we can talk about how to get it merged.
+
+Project members can access crash reports [here](https://geeksville.sentry.io/insights/projects/starbash/?project=4510264204132352).

{starbash-0.1.1 → starbash-0.1.4}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "starbash"
-version = "0.1.1"
-description = ""
+version = "0.1.4"
+description = "A tool for automating/standardizing/sharing astrophotography workflows."
 authors = ["Kevin Hester <kevinh@geeksville.com>"]
 readme = "README.md"
 packages = [{ include = "starbash", from = "src" }]
@@ -19,6 +19,7 @@ sentry-sdk = "^2.42.1"
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=8.4.2,<9.0.0"
+pytest-cov = "^6.0.0"
 
 [tool.poetry.scripts]
 starbash = "starbash.main:app"
@@ -28,6 +29,24 @@ sb = "starbash.main:app"       # std alias for convenience
 markers = ["slow: marks tests as slow (deselect with '-m \"not slow\"')"]
 addopts = "-m 'not slow'"
 
+[tool.coverage.run]
+source = ["src"]
+omit = ["*/tests/*", "*/__pycache__/*"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+]
+show_missing = true
+precision = 2
+
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"

{starbash-0.1.1 → starbash-0.1.4}/src/starbash/__init__.py

@@ -1,6 +1,11 @@
+import logging
+
 from .database import Database  # re-export for convenience
 from rich.console import Console
 
 console = Console()
 
+# Global variable for log filter level (can be changed via --debug flag)
+log_filter_level = logging.INFO
+
 __all__ = ["Database"]

{starbash-0.1.1 → starbash-0.1.4}/src/starbash/analytics.py

@@ -1,5 +1,7 @@
 import logging
+import os
 
+import starbash
 from starbash import console
 import starbash.url as url
 
@@ -8,11 +10,12 @@ analytics_allowed = False
 
 
 def analytics_setup(allowed: bool = False, user_email: str | None = None) -> None:
-    import sentry_sdk
-
     global analytics_allowed
     analytics_allowed = allowed
     if analytics_allowed:
+        import sentry_sdk
+        from sentry_sdk.integrations.logging import LoggingIntegration
+
         logging.info(
             f"Analytics/crash-reports enabled.  To change [link={url.analytics_docs}]click here[/link]",
             extra={"markup": True},
@@ -22,6 +25,13 @@ def analytics_setup(allowed: bool = False, user_email: str | None = None) -> Non
             send_default_pii=True,
             enable_logs=True,
             traces_sample_rate=1.0,
+            integrations=[
+                LoggingIntegration(
+                    level=starbash.log_filter_level,  # Capture INFO and above as breadcrumbs
+                    event_level=None,  # Don't automatically convert error messages to sentry events
+                    sentry_logs_level=starbash.log_filter_level,  # Capture INFO and above as logs
+                ),
+            ],
         )
 
         if user_email:
@@ -41,11 +51,13 @@ def analytics_shutdown() -> None:
         sentry_sdk.flush()
 
 
+def is_running_in_pytest() -> bool:
+    """Detect if code is being run inside pytest."""
+    return "PYTEST_CURRENT_TEST" in os.environ
+
+
 def is_development_environment() -> bool:
     """Detect if running in a development environment."""
-    import os
-    import sys
-    from pathlib import Path
 
     # Check for explicit environment variable
     if os.getenv("STARBASH_ENV") == "development":
@@ -68,7 +80,10 @@ def analytics_exception(exc: Exception) -> bool:
     if analytics_allowed:
         import sentry_sdk
 
-        report_id = sentry_sdk.capture_exception(exc)
+        if is_running_in_pytest():
+            report_id = "TESTING-ENVIRONMENT"
+        else:
+            report_id = sentry_sdk.capture_exception(exc)
 
         logging.info(
             f"""An unexpected error has occurred and been reported.  Thank you for your help.

{starbash-0.1.1 → starbash-0.1.4}/src/starbash/app.py

@@ -1,7 +1,7 @@
 import logging
 from importlib import resources
 from pathlib import Path
-
+import typer
 import tomlkit
 from tomlkit.toml_file import TOMLFile
 import glob
@@ -10,6 +10,10 @@ from astropy.io import fits
 import itertools
 from rich.progress import track
 from rich.logging import RichHandler
+import shutil
+
+import starbash
+from starbash import console
 from starbash.database import Database
 from starbash.repo.manager import Repo
 from starbash.tool import Tool
@@ -31,30 +35,81 @@ def setup_logging():
     Configures basic logging.
     """
     logging.basicConfig(
-        level="INFO",  # don't print messages of lower priority than this
+        level=starbash.log_filter_level,  # use the global log filter level
         format="%(message)s",
         datefmt="[%X]",
         handlers=[RichHandler(rich_tracebacks=True)],
     )
 
 
-setup_logging()
+def get_user_config_path() -> Path:
+    """Returns the path to the user config file."""
+    config_dir = get_user_config_dir()
+    return config_dir / "starbash.toml"
 
 
 def create_user() -> Path:
     """Create user directories if they don't exist yet."""
-    config_dir = get_user_config_dir()
-    userconfig_path = config_dir / "starbash.toml"
-    if not (userconfig_path).exists():
+    path = get_user_config_path()
+    if not path.exists():
         tomlstr = (
             resources.files("starbash")
             .joinpath("templates/userconfig.toml")
             .read_text()
         )
         toml = tomlkit.parse(tomlstr)
-        TOMLFile(userconfig_path).write(toml)
-        logging.info(f"Created user config file: {userconfig_path}")
-    return config_dir
+        TOMLFile(path).write(toml)
+        logging.info(f"Created user config file: {path}")
+    return get_user_config_dir()
+
+
+def copy_images_to_dir(images: list[dict[str, Any]], output_dir: Path) -> None:
+    """Copy images to the specified output directory (using symbolic links if possible)."""
+
+    # Export images
+    console.print(f"[cyan]Exporting {len(images)} images to {output_dir}...[/cyan]")
+
+    linked_count = 0
+    copied_count = 0
+    error_count = 0
+
+    for image in images:
+        # Get the source path from the image metadata
+        source_path = Path(image.get("path", ""))
+
+        if not source_path.exists():
+            console.print(f"[red]Warning: Source file not found: {source_path}[/red]")
+            error_count += 1
+            continue
+
+        # Determine destination filename
+        dest_path = output_dir / source_path.name
+        if dest_path.exists():
+            console.print(f"[yellow]Skipping existing file: {dest_path}[/yellow]")
+            error_count += 1
+            continue
+
+        # Try to create a symbolic link first
+        try:
+            dest_path.symlink_to(source_path.resolve())
+            linked_count += 1
+        except (OSError, NotImplementedError):
+            # If symlink fails, try to copy
+            try:
+                shutil.copy2(source_path, dest_path)
+                copied_count += 1
+            except Exception as e:
+                console.print(f"[red]Error copying {source_path.name}: {e}[/red]")
+                error_count += 1
+
+    # Print summary
+    console.print(f"[green]Export complete![/green]")
+    if linked_count > 0:
+        console.print(f"  Linked: {linked_count} files")
+    if copied_count > 0:
+        console.print(f"  Copied: {copied_count} files")
+    if error_count > 0:
+        console.print(f"  [red]Errors: {error_count} files[/red]")
 
 
 class Starbash:
@@ -89,7 +144,7 @@ class Starbash:
             self.analytics.__enter__()
 
         logging.info(
-            f"Repo manager initialized with {len(self.repo_manager.repos)} default repo references."
+            f"Repo manager initialized with {len(self.repo_manager.repos)} repos."
         )
         # self.repo_manager.dump()
 
@@ -117,7 +172,8 @@ class Starbash:
 
     def __exit__(self, exc_type, exc, tb) -> bool:
         handled = False
-        if exc:
+        # Don't suppress typer.Exit - it's used for controlled exit codes
+        if exc and not isinstance(exc, typer.Exit):
             handled = analytics_exception(exc)
         self.close()
         return handled
@@ -128,11 +184,12 @@ class Starbash:
         date = header.get(Database.DATE_OBS_KEY)
         if not date or not image_type:
             logging.warning(
-                "Image %s missing critical FITS header, please submit image at https://github.com/geeksville/starbash/issues/new",
+                "Image %s missing either DATE-OBS or IMAGETYP FITS header, skipping...",
                 f,
             )
         else:
             exptime = header.get(Database.EXPTIME_KEY, 0)
+            telescop = header.get(Database.TELESCOP_KEY, "unspecified")
             new = {
                 Database.FILTER_KEY: filter,
                 Database.START_KEY: date,
@@ -142,6 +199,7 @@ class Starbash:
                 Database.NUM_IMAGES_KEY: 1,
                 Database.EXPTIME_TOTAL_KEY: exptime,
                 Database.OBJECT_KEY: header.get(Database.OBJECT_KEY, "unspecified"),
+                Database.TELESCOP_KEY: telescop,
             }
             session = self.db.get_session(new)
             self.db.upsert_session(new, existing=session)
@@ -156,16 +214,86 @@ class Starbash:
             conditions = self.selection.get_query_conditions()
             return self.db.search_session(conditions)
 
+    def get_session_images(self, session_id: int) -> list[dict[str, Any]]:
+        """
+        Get all images belonging to a specific session.
+
+        Sessions are defined by a unique combination of filter, imagetyp (image type),
+        object (target name), telescope, and date range. This method queries the images
+        table for all images matching the session's criteria in a single database query.
+
+        Args:
+            session_id: The database ID of the session
+
+        Returns:
+            List of image records (dictionaries with path, metadata, etc.)
+            Returns empty list if session not found or has no images.
+
+        Raises:
+            ValueError: If session_id is not found in the database
+        """
+        # First get the session details
+        session = self.db.get_session_by_id(session_id)
+        if session is None:
+            raise ValueError(f"Session with id {session_id} not found")
+
+        # Query images that match ALL session criteria including date range
+        conditions = {
+            Database.FILTER_KEY: session[Database.FILTER_KEY],
+            Database.IMAGETYP_KEY: session[Database.IMAGETYP_KEY],
+            Database.OBJECT_KEY: session[Database.OBJECT_KEY],
+            Database.TELESCOP_KEY: session[Database.TELESCOP_KEY],
+            "date_start": session[Database.START_KEY],
+            "date_end": session[Database.END_KEY],
+        }
+
+        # Single query with all conditions
+        images = self.db.search_image(conditions)
+        return images if images else []
+
+    def remove_repo_ref(self, url: str) -> None:
+        """
+        Remove a repository reference from the user configuration.
+
+        Args:
+            url: The repository URL to remove (e.g., 'file:///path/to/repo')
+
+        Raises:
+            ValueError: If the repository URL is not found in user configuration
+        """
+        # Get the repo-ref list from user config
+        repo_refs = self.user_repo.config.get("repo-ref")
+
+        if not repo_refs:
+            raise ValueError(f"No repository references found in user configuration.")
+
+        # Find and remove the matching repo-ref
+        found = False
+        refs_copy = [r for r in repo_refs]  # Make a copy to iterate
+        for ref in refs_copy:
+            ref_dir = ref.get("dir", "")
+            # Match by converting to file:// URL format if needed
+            if ref_dir == url or f"file://{ref_dir}" == url:
+                repo_refs.remove(ref)
+                found = True
+                break
+
+        if not found:
+            raise ValueError(f"Repository '{url}' not found in user configuration.")
+
+        # Write the updated config
+        self.user_repo.write_config()
+
     def reindex_repo(self, repo: Repo, force: bool = False):
         """Reindex all repositories managed by the RepoManager."""
         # FIXME, add a method to get just the repos that contain images
         if repo.is_scheme("file") and repo.kind != "recipe":
             logging.debug("Reindexing %s...", repo.url)
 
+            whitelist = None
             config = self.repo_manager.merged.get("config")
-            if not config:
-                raise ValueError(f"App config not found.")
-            whitelist = config["fits-whitelist"]
+            if config:
+                whitelist = config.get("fits-whitelist", None)
 
             path = repo.get_path()
             if not path:
@@ -191,7 +319,7 @@ class Starbash:
                             items = header.items()
                             headers = {}
                             for key, value in items:
-                                if key in whitelist:
+                                if (not whitelist) or (key in whitelist):
                                     headers[key] = value
                             logging.debug("Headers for %s: %s", f, headers)
                             headers["path"] = str(f)
@@ -207,7 +335,7 @@ class Starbash:
 
     def reindex_repos(self, force: bool = False):
         """Reindex all repositories managed by the RepoManager."""
-        logging.info("Reindexing all repositories...")
+        logging.debug("Reindexing all repositories...")
 
         for repo in track(self.repo_manager.repos, description="Reindexing repos..."):
             self.reindex_repo(repo, force=force)