arcsecond 3.16.2__tar.gz → 3.17.0__tar.gz

arcsecond-3.17.0/.flake8

@@ -0,0 +1,12 @@
+[flake8]
+# The same limits the lint job and the pre-commit hook pass on the command
+# line, kept here so that a bare `flake8` agrees with them.
+max-line-length = 127
+max-complexity = 10
+
+# E203 (whitespace before ':') contradicts black, which the same lint job
+# enforces: black writes `lines[begin : end + 1]` and pycodestyle objects to
+# the space. Black is the formatter of record here, so this one is ignored
+# rather than fought — fixing it in code would only be undone on the next
+# `black` run.
+extend-ignore = E203

{arcsecond-3.16.2 → arcsecond-3.17.0}/.github/workflows/tests.yml

@@ -72,9 +72,15 @@ jobs:
       - name: Install dev dependencies
         run: uv sync --group dev
 
-      - name: Lint with flake8
+      - name: Lint with flake8 (errors)
         run: uv run flake8 arcsecond tests --count --select=E9,F63,F7,F82 --show-source --statistics
 
+      # Style and complexity, on the limits in .flake8. Blocking rather than
+      # advisory: the tree is clean, and the point of getting it there was to
+      # keep it there.
+      - name: Lint with flake8 (style and complexity)
+        run: uv run flake8 arcsecond tests --count --statistics
+
       - name: Check formatting with black
         run: uv run black --check arcsecond tests
 

{arcsecond-3.16.2 → arcsecond-3.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: arcsecond
-Version: 3.16.2
+Version: 3.17.0
 Summary: CLI for arcsecond.io
 Project-URL: Homepage, https://github.com/arcsecond-io/cli
 Project-URL: Issues, https://github.com/arcsecond-io/cli/issues
@@ -62,6 +62,22 @@ public and private ones.
 
 [Read the docs](https://docs.arcsecond.io/cli)
 
+## Configuration
+
+Credentials and settings live in `~/.config/arcsecond/`, alongside the list of
+registered cameras and the live-image proxy's runtime files.
+
+Set `ARCSECOND_CONFIG_DIR` to put them somewhere else:
+
+```bash
+$ ARCSECOND_CONFIG_DIR=~/.config/arcsecond-observatory arcsecond login
+```
+
+Useful for keeping a personal account and an observatory's apart, and for
+containers or CI jobs that should not touch a home directory. Child processes
+the CLI starts — such as the background proxy from `arcsecond proxy start` —
+inherit it.
+
 # Development
 
 The project uses [uv](https://docs.astral.sh/uv/) for environment and
@@ -78,6 +94,11 @@ $ uv run pytest
 and the `dev` dependency group (pytest, black, flake8, isort). Prefix
 commands with `uv run` or activate the venv with `source .venv/bin/activate`.
 
+The test suite writes nothing to your own configuration: an autouse fixture in
+`tests/conftest.py` points `ARCSECOND_CONFIG_DIR` at a temporary directory for
+the whole run. Several tests save real-looking credentials, so if you add one
+that touches `ArcsecondConfig`, leave that fixture in place.
+
 
 ## License
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Farcsecond-io%2Fcli.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Farcsecond-io%2Fcli?ref=badge_large)

{arcsecond-3.16.2 → arcsecond-3.17.0}/README.md

@@ -9,6 +9,22 @@ public and private ones.
 
 [Read the docs](https://docs.arcsecond.io/cli)
 
+## Configuration
+
+Credentials and settings live in `~/.config/arcsecond/`, alongside the list of
+registered cameras and the live-image proxy's runtime files.
+
+Set `ARCSECOND_CONFIG_DIR` to put them somewhere else:
+
+```bash
+$ ARCSECOND_CONFIG_DIR=~/.config/arcsecond-observatory arcsecond login
+```
+
+Useful for keeping a personal account and an observatory's apart, and for
+containers or CI jobs that should not touch a home directory. Child processes
+the CLI starts — such as the background proxy from `arcsecond proxy start` —
+inherit it.
+
 # Development
 
 The project uses [uv](https://docs.astral.sh/uv/) for environment and
@@ -25,6 +41,11 @@ $ uv run pytest
 and the `dev` dependency group (pytest, black, flake8, isort). Prefix
 commands with `uv run` or activate the venv with `source .venv/bin/activate`.
 
+The test suite writes nothing to your own configuration: an autouse fixture in
+`tests/conftest.py` points `ARCSECOND_CONFIG_DIR` at a temporary directory for
+the whole run. Several tests save real-looking credentials, so if you add one
+that touches `ArcsecondConfig`, leave that fixture in place.
+
 
 ## License
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Farcsecond-io%2Fcli.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Farcsecond-io%2Fcli?ref=badge_large)

{arcsecond-3.16.2 → arcsecond-3.17.0}/arcsecond/api/config.py

@@ -1,3 +1,4 @@
+import os
 import shutil
 from configparser import ConfigParser
 from pathlib import Path
@@ -8,6 +9,19 @@ from arcsecond.options import State
 
 from .constants import ARCSECOND_API_URL_PROD
 
+# Where the configuration lives, when it is not to live in the usual place.
+#
+# Set this to keep several sets of credentials apart — a personal account and
+# an observatory's, say — or to point a container or a CI job at a directory of
+# its own. It is also what the test suite uses: the tests write real-looking
+# credentials, and without somewhere else to put them they would land in the
+# developer's own config file and stay there.
+#
+# An environment variable rather than something passed in, because the CLI
+# starts child processes of its own (`arcsecond proxy start`), and those have
+# to end up in the same place as the command that started them.
+CONFIG_DIR_ENV_VAR = "ARCSECOND_CONFIG_DIR"
+
 
 class ArcsecondConfig(object):
     def __init__(self, **kwargs):
@@ -31,16 +45,33 @@ class ArcsecondConfig(object):
         return (Path.home() / ".arcsecond.ini").expanduser()
 
     @classmethod
-    def dir_path(cls):
-        _config_root_path = Path.home() / ".config"
-        return _config_root_path / "arcsecond"
+    def is_dir_path_overridden(cls) -> bool:
+        return bool(os.environ.get(CONFIG_DIR_ENV_VAR, "").strip())
+
+    @classmethod
+    def dir_path(cls) -> Path:
+        """The directory holding config.ini and everything beside it.
+
+        ``$ARCSECOND_CONFIG_DIR`` wins when it is set; otherwise the usual
+        ``~/.config/arcsecond``.
+        """
+        override = os.environ.get(CONFIG_DIR_ENV_VAR, "").strip()
+        if override:
+            return Path(override).expanduser()
+        return Path.home() / ".config" / "arcsecond"
 
     @classmethod
     def file_path(cls) -> Path:
         _config_dir_path = ArcsecondConfig.dir_path()
         _config_file_path = _config_dir_path / "config.ini"
+
+        # The one-time move of the pre-0.9 ~/.arcsecond.ini happens only for
+        # the real config directory. Doing it for an overridden one would take
+        # the file out of the operator's home and drop it somewhere temporary —
+        # which, during a test run, would destroy it.
         if (
-            ArcsecondConfig.__old_config_file_path().exists()
+            not ArcsecondConfig.is_dir_path_overridden()
+            and ArcsecondConfig.__old_config_file_path().exists()
             and not _config_file_path.exists()
         ):
             _config_dir_path.mkdir(parents=True, exist_ok=True)

{arcsecond-3.16.2 → arcsecond-3.17.0}/arcsecond/cli.py

@@ -64,11 +64,25 @@ main.add_command(backups)
 # Manage the Arcsecond.local database (e.g. `arcsecond db set-password`).
 main.add_command(db)
 
-# Native live-image proxy — exposes USB webcams, all-sky cameras and network
-# cameras to Arcsecond.local Docker containers via host.docker.internal.
+# Cameras, and the native live-image proxy that exposes them to
+# Arcsecond.local Docker containers via host.docker.internal. `webcam` covers
+# every camera the machine can reach, whether over USB or over the network;
+# `allsky` covers all-sky cameras writing JPEGs to disk; `proxy` runs the one
+# server that serves whatever those two registered.
 main.add_command(imagesources.webcam)
 main.add_command(imagesources.allsky)
+main.add_command(imagesources.proxy)
+
+# Removed: a network camera is a webcam. Kept only to say so — see commands.py.
 main.add_command(imagesources.netcam)
 
 # Local ASCOM Alpaca diagnostics (e.g. `arcsecond alpaca probe dome ...`).
 main.add_command(alpaca_group)
+
+
+# `arcsecond proxy start` launches its detached proxy as
+# `python -m arcsecond.cli proxy start --foreground`, which needs this. Going
+# through the interpreter rather than the console script means the background
+# proxy runs on the very same Python as the command that started it.
+if __name__ == "__main__":
+    main()

{arcsecond-3.16.2 → arcsecond-3.17.0}/arcsecond/cloud/__init__.py

@@ -8,3 +8,17 @@ from .uploader.constants import Status, Substatus
 from .uploads import (
     upload_data,
 )
+
+# Re-exported: this is the package's public surface.
+__all__ = [
+    "api",
+    "login",
+    "me",
+    "datasets",
+    "telescopes",
+    "DatasetFileUploader",
+    "DatasetUploadContext",
+    "Status",
+    "Substatus",
+    "upload_data",
+]

{arcsecond-3.16.2 → arcsecond-3.17.0}/arcsecond/cloud/auth.py

@@ -22,7 +22,8 @@ pass_state = click.make_pass_decorator(State, ensure=True)
     required=True,
     type=click.Choice(["access", "upload"], case_sensitive=False),
     prompt=True,
-    help="Your access key (a.k.a. API key). Visit your settings page to copy and paste it here. One of Access or Upload key must be provided.",
+    help="Your access key (a.k.a. API key). Visit your settings page to copy "
+    "and paste it here. One of Access or Upload key must be provided.",
 )
 @click.option(
     "--key",

{arcsecond-3.16.2 → arcsecond-3.17.0}/arcsecond/cloud/uploader/__init__.py

@@ -5,4 +5,5 @@ from .datafiles.utils import display_upload_datafiles_command_summary
 __all__ = [
     "DatasetUploadContext",
     "DatasetFileUploader",
+    "display_upload_datafiles_command_summary",
 ]

{arcsecond-3.16.2 → arcsecond-3.17.0}/arcsecond/cloud/uploader/datafiles/utils.py

@@ -61,7 +61,10 @@ def _display_custom_tags_info(context: DatasetUploadContext):
 def _display_telescope_info(context: DatasetUploadContext):
     """Displays telescope-related information."""
     if context.telescope:
-        msg = f" • Dataset will be attached to the telescope named '{context.telescope.get('name')}' ({context.telescope.get('uuid')})."
+        msg = (
+            f" • Dataset will be attached to the telescope named "
+            f"'{context.telescope.get('name')}' ({context.telescope.get('uuid')})."
+        )
         click.echo(msg)
     elif not context.dataset_uuid and context.dataset_name:
         msg = " • Dataset will not be attached to any telescope. It can be changed later in the web."

{arcsecond-3.16.2 → arcsecond-3.17.0}/arcsecond/cloud/uploader/errors.py

@@ -8,7 +8,7 @@ class UploadRemoteFileError(ArcsecondError):
 class UploadRemoteFileInvalidatedContextError(ArcsecondError):
     def __init__(self, msg=""):
         super().__init__(
-            f"The UploadContext must be validated first. Call `context.validate()`."
+            "The UploadContext must be validated first. Call `context.validate()`."
         )
 
 

{arcsecond-3.16.2 → arcsecond-3.17.0}/arcsecond/cloud/uploader/logger.py

@@ -1,15 +1,12 @@
 import os
-from datetime import datetime
 from logging import (
     DEBUG,
     INFO,
-    FileHandler,
     Formatter,
     Logger,
     StreamHandler,
     getLogger,
 )
-from pathlib import Path
 
 
 def get_logger(debug=False) -> Logger:

{arcsecond-3.16.2 → arcsecond-3.17.0}/arcsecond/hosting/__init__.py

@@ -2,3 +2,6 @@
 from .backups import backups
 from .database import db
 from .local import setup
+
+# Re-exported: the command groups `arcsecond.cli` mounts.
+__all__ = ["backups", "db", "setup"]