starbash 0.1.0__tar.gz → 0.1.3__tar.gz

starbash-0.1.3/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: starbash
+Version: 0.1.3
+Summary: 
+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)
+![GitHub branch check runs](https://img.shields.io/github/check-runs/geeksville/starbash/main)
+
+ ![app icon](https://github.com/geeksville/starbash/blob/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 recipies 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
+```
+
+## Supported commands
+
+### Setup & Configuration
+- `sb setup` - Configure starbash via a brief guided process
+- `sb info` - Show user preferences location and other app info
+
+### 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
+
+### Selection & Filtering
+- `sb selection` - Show information about the current selection
+- `sb selection any` - Remove all filters (select everything)
+- `sb selection target <TARGETNAME>` - Limit selection to the named target
+- `sb selection telescope <TELESCOPENAME>` - Limit selection to the named telescope
+- `sb selection date <after|before|between> <DATE> [DATE]` - Limit to sessions in the specified date range
+
+### Viewing Data
+- `sb session` - List sessions (filtered based on the current selection)
+- `sb target` - List targets (filtered based on the current selection)
+- `sb instrument` - List instruments (filtered based on the current selection)
+- `sb filter` - List all filters found in current selection
+
+### Export & Processing
+- `sb export <dirs|BIAS|LIGHT|DARK|FLAT> [DIRLOC]` - Export data
+- `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 recipies 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.

starbash-0.1.3/README.md

@@ -0,0 +1,92 @@
+# Starbash
+
+![PyPI - Version](https://img.shields.io/pypi/v/starbash)
+![GitHub branch check runs](https://img.shields.io/github/check-runs/geeksville/starbash/main)
+
+ ![app icon](https://github.com/geeksville/starbash/blob/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 recipies 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
+```
+
+## Supported commands
+
+### Setup & Configuration
+- `sb setup` - Configure starbash via a brief guided process
+- `sb info` - Show user preferences location and other app info
+
+### 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
+
+### Selection & Filtering
+- `sb selection` - Show information about the current selection
+- `sb selection any` - Remove all filters (select everything)
+- `sb selection target <TARGETNAME>` - Limit selection to the named target
+- `sb selection telescope <TELESCOPENAME>` - Limit selection to the named telescope
+- `sb selection date <after|before|between> <DATE> [DATE]` - Limit to sessions in the specified date range
+
+### Viewing Data
+- `sb session` - List sessions (filtered based on the current selection)
+- `sb target` - List targets (filtered based on the current selection)
+- `sb instrument` - List instruments (filtered based on the current selection)
+- `sb filter` - List all filters found in current selection
+
+### Export & Processing
+- `sb export <dirs|BIAS|LIGHT|DARK|FLAT> [DIRLOC]` - Export data
+- `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 recipies 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.

{starbash-0.1.0 → starbash-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "starbash"
-version = "0.1.0"
+version = "0.1.3"
 description = ""
 authors = ["Kevin Hester <kevinh@geeksville.com>"]
 readme = "README.md"
@@ -13,9 +13,9 @@ multidict = ">=6.7.0,<7.0.0"
 rich = ">=14.2.0,<15.0.0"
 restrictedpython = ">=8.1,<9.0"
 astropy = ">=7.1.1,<8.0.0"
-tinydb = ">=4.8.2,<5.0.0"
 platformdirs = ">=4.5.0,<5.0.0"
 typer = "^0.20.0"
+sentry-sdk = "^2.42.1"
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=8.4.2,<9.0.0"
@@ -24,6 +24,10 @@ pytest = ">=8.4.2,<9.0.0"
 starbash = "starbash.main:app"
 sb = "starbash.main:app"       # std alias for convenience
 
+[tool.pytest.ini_options]
+markers = ["slow: marks tests as slow (deselect with '-m \"not slow\"')"]
+addopts = "-m 'not slow'"
+
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"

starbash-0.1.3/src/starbash/analytics.py

@@ -0,0 +1,121 @@
+import logging
+
+from starbash import console
+import starbash.url as url
+
+# Default to no analytics/auto crash reports
+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:
+        logging.info(
+            f"Analytics/crash-reports enabled.  To change [link={url.analytics_docs}]click here[/link]",
+            extra={"markup": True},
+        )
+        sentry_sdk.init(
+            dsn="https://e9496a4ea8b37a053203a2cbc10d64e6@o209837.ingest.us.sentry.io/4510264204132352",
+            send_default_pii=True,
+            enable_logs=True,
+            traces_sample_rate=1.0,
+        )
+
+        if user_email:
+            sentry_sdk.set_user({"email": user_email})
+    else:
+        logging.info(
+            f"Analytics/crash-reports disabled.  To learn more [link={url.analytics_docs}]click here[/link]",
+            extra={"markup": True},
+        )
+
+
+def analytics_shutdown() -> None:
+    """Shut down the analytics service, if enabled."""
+    if analytics_allowed:
+        import sentry_sdk
+
+        sentry_sdk.flush()
+
+
+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":
+        return True
+
+    # Check if running under VS Code
+    if any(k.startswith("VSCODE_") for k in os.environ):
+        return True
+
+    return False
+
+
+def analytics_exception(exc: Exception) -> bool:
+    """Report an exception to the analytics service, if enabled.
+    return True to suppress exception propagation/log messages"""
+
+    if is_development_environment():
+        return False  # We want to let devs see full exception traces
+
+    if analytics_allowed:
+        import sentry_sdk
+
+        report_id = sentry_sdk.capture_exception(exc)
+
+        logging.info(
+            f"""An unexpected error has occurred and been reported.  Thank you for your help.
+                If you'd like to chat with the devs about it, please click
+                [link={url.new_issue(str(report_id))}]here[/link] to open an issue.""",
+            extra={"markup": True},
+        )
+    else:
+        logging.error(
+            f"""An unexpected error has occurred. Automated crash reporting is disabled,
+                      but we encourage you to contact the developers
+                      at [link={url.new_issue()}]here[/link] and we will try to help.
+
+                      The full exception is: {exc}""",
+            extra={"markup": True},
+        )
+    return True
+
+
+class NopAnalytics:
+    """Used when users have disabled analytics/crash reporting."""
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        return False
+
+    def set_data(self, key, value):
+        pass
+
+
+def analytics_start_span(**kwargs):
+    """Start an analytics/tracing span if analytics is enabled, otherwise return a no-op context manager."""
+    if analytics_allowed:
+        import sentry_sdk
+
+        return sentry_sdk.start_span(**kwargs)
+    else:
+        return NopAnalytics()
+
+
+def analytics_start_transaction(**kwargs):
+    """Start an analytics/tracing transaction if analytics is enabled, otherwise return a no-op context manager."""
+    if analytics_allowed:
+        import sentry_sdk
+
+        return sentry_sdk.start_transaction(**kwargs)
+    else:
+        return NopAnalytics()