citrascope 0.5.1__tar.gz

citrascope-0.5.1/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+	"name": "Python 3",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "sudo apt-get update && sudo apt-get install -y cmake libdbus-1-dev && python3 -m pip install --upgrade pip && pip3 install pre-commit && pip3 install ."
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

citrascope-0.5.1/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 120
+extend-ignore = E203, W503

citrascope-0.5.1/.github/copilot-instructions.md

@@ -0,0 +1,105 @@
+# Copilot Instructions for CitraScope
+
+## Overview
+This project is a Python package for interacting with astronomical data and services. It includes modules for API clients, INDI client integration, logging, settings management, and task execution. Tests are located in the `tests/` directory.
+
+## Coding Guidelines
+- Follow PEP8 for Python code style.
+- Use type hints for all public functions and methods.
+- Write docstrings for all modules, classes, and functions.
+- Prefer logging via the custom logger in `citrascope/logging/` over print statements.
+- Organize code into logical modules as per the existing structure.
+
+## Directory Structure
+- `citrascope/api/`: API client code
+- `citrascope/hardware/`: Hardware adapter implementations and registry
+  - `adapter_registry.py`: Central registry for all hardware adapters (add new adapters here)
+  - `abstract_astro_hardware_adapter.py`: Base class all adapters must implement
+  - Individual adapter implementations (indi_adapter.py, nina_adv_http_adapter.py, etc.)
+- `citrascope/logging/`: Logging utilities
+- `citrascope/settings/`: Settings and configuration
+- `citrascope/tasks/`: Task runner and definitions
+- `citrascope/web/`: Web interface for monitoring and configuration
+  - `citrascope/web/app.py`: FastAPI application and routes
+  - `citrascope/web/server.py`: Web server management and threading
+  - `citrascope/web/templates/`: HTML templates
+  - `citrascope/web/static/`: CSS and JavaScript files
+- `tests/`: Unit and integration tests
+
+## Testing
+- All new features and bug fixes should include corresponding tests in `tests/`.
+- Use pytest for running tests.
+- Test files should be named `test_*.py`.
+
+## Copilot Usage
+- When implementing new features, follow the module structure and add tests.
+- For bug fixes, describe the issue and expected behavior in comments or commit messages.
+- For refactoring, ensure no breaking changes and all tests pass.
+- Use Copilot to suggest code, refactor, and generate tests, but always review suggestions for correctness and style.
+
+## Common Tasks
+- Add new API integrations in `citrascope/api/`.
+- Extend or add hardware adapters:
+  - Create new adapter class implementing `AbstractAstroHardwareAdapter` in `citrascope/hardware/`
+  - Register it in `citrascope/hardware/adapter_registry.py` by adding an entry to `REGISTERED_ADAPTERS`
+  - All adapter discovery and instantiation flows from this registry
+- Update logging logic in `citrascope/logging/`.
+- Change settings in `citrascope/settings/`.
+- Add or modify tasks in `citrascope/tasks/`.
+- Enhance web interface in `citrascope/web/`.
+- Write or update tests in `tests/`.
+
+## Web Interface Guidelines
+
+The web interface provides real-time monitoring and configuration for telescope operations. When working on web-related features:
+
+### Design Principles
+- **Dark theme required**: All UI elements must use dark colors suitable for nighttime telescope operations to preserve night vision
+- **Real-time updates**: Use WebSocket connections for live status, logs, and telemetry
+- **Mobile-friendly**: The interface should be responsive and usable on tablets/phones in the field
+- **Minimal distractions**: Reduce visual clutter; prioritize essential telescope and task information
+
+### Architecture
+- **FastAPI backend** (`web/app.py`): RESTful API endpoints and WebSocket handlers
+- **Separate thread**: Web server runs in daemon thread with its own event loop (`web/server.py`)
+- **Log streaming**: Custom `WebLogHandler` broadcasts logs to web clients in real-time
+- **Static files**: HTML, CSS, and JavaScript are served from `web/templates/` and `web/static/`
+
+### Development Notes
+- Keep web-specific code isolated in the `citrascope/web/` directory
+- The daemon should only call `web_server.start()` - all web complexity stays in `web/server.py`
+- Filter out noise from web logs (HTTP requests, WebSocket events, Uvicorn messages)
+- Use thread-safe mechanisms when accessing daemon state from web handlers
+- Port 24872 (CITRA on phone keypad) is the default web interface port
+
+## Important Packages
+
+This project relies on several key Python packages. Below are some of the most important ones and their roles:
+
+- **Click**: Used for building the command-line interface (CLI). The main entry point for the application (`python -m citrascope`) is implemented using Click.
+- **Pydantic-Settings**: Manages configuration and settings, ensuring type safety and validation for environment variables.
+- **Requests** and **HTTPX**: Handle HTTP requests for interacting with the Citra.space API.
+- **Python-Dateutil**: Provides robust date and time parsing utilities.
+- **PyINDI-Client**: Interfaces with INDI telescope hardware, enabling communication with telescope and camera devices.
+- **Skyfield**: Used for astronomical calculations, such as determining celestial positions.
+- **Pytest** and **Pytest-Cov**: Facilitate unit testing and code coverage analysis.
+
+### Development Dependencies
+- **Black**: Ensures consistent code formatting.
+- **Pre-Commit**: Runs code quality checks automatically before commits.
+- **Isort**: Sorts imports to maintain a clean and organized structure.
+- **Mypy**: Performs static type checking.
+- **Flake8**: Enforces code style and linting rules.
+- **Sphinx**: Generates project documentation.
+
+### Web Interface Dependencies
+- **FastAPI**: Modern async web framework for the monitoring interface
+- **Uvicorn**: ASGI server for running the web application
+- **WebSockets**: Real-time bidirectional communication for live updates
+
+For a complete list of dependencies, refer to the `pyproject.toml` file.
+
+## Additional Notes
+- Keep dependencies minimal and update `pyproject.toml` as needed.
+- Documentation is maintained in the [citra-space/docs](https://github.com/citra-space/docs) repository under `docs/citrascope/`.
+- Use pre-commit hooks for code quality.

citrascope-0.5.1/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for more information:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://containers.dev/guide/dependabot
+
+version: 2
+updates:
+ - package-ecosystem: "devcontainers"
+   directory: "/"
+   schedule:
+     interval: weekly

citrascope-0.5.1/.github/workflows/pypi-publish.yml

@@ -0,0 +1,24 @@
+name: Publish Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install build tools
+        run: pip install build twine
+      - name: Build package
+        run: python -m build
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: twine upload dist/*

citrascope-0.5.1/.github/workflows/pytest.yml

@@ -0,0 +1,37 @@
+name: Pytest
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install project prerequisites
+        run: sudo apt-get update && sudo apt-get install -y libglib2.0-dev libdbus-1-dev libjpeg-dev zlib1g-dev
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install .[dev,test,indi,all]
+      - name: Run pytest with coverage
+        run: |
+          pytest -m "not integration" --cov=citrascope --cov-report=term-missing --cov-report=xml --cov-branch
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        if: matrix.python-version == '3.12'
+        with:
+          name: coverage-xml
+          path: coverage.xml

citrascope-0.5.1/.gitignore

@@ -0,0 +1,139 @@
+# 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/
+pip-wheel-metadata/
+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/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+prod.env
+.env.prod
+.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/
+.vscode/extensions.json
+.vscode/settings.json
+.vscode/tasks.json
+
+as_headers/
+
+certs/
+de421.bsp
+citra_image.fits
+/images/*
+.DS_Store
+hip_main.dat
+nina_sequence_*.json
+nina_focus_positions.json

citrascope-0.5.1/.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+repos:
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: check-added-large-files
+    exclude: data
+  - id: check-case-conflict
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+    exclude: data
+  - id: trailing-whitespace
+    exclude: data
+
+- repo: https://github.com/pycqa/isort
+  rev: 7.0.0
+  hooks:
+    - id: isort
+
+- repo: https://github.com/psf/black
+  rev: 25.9.0
+  hooks:
+    - id: black
+
+- repo: local
+  hooks:
+    - id: pytest
+      name: pytest
+      entry: pytest
+      language: system
+      types: [python]
+      pass_filenames: false

citrascope-0.5.1/.python-version

@@ -0,0 +1 @@
+3.12

citrascope-0.5.1/.vscode/launch.json

@@ -0,0 +1,25 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: citrascope",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "citrascope",
+            "args": [],
+            "console": "integratedTerminal",
+            "justMyCode": false
+        },
+        {
+            "name": "Python: citrascope (custom port)",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "citrascope",
+            "args": ["--web-port", "8080"],
+            "console": "integratedTerminal",
+            "justMyCode": false
+        }
+    ]
+}

citrascope-0.5.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Citra Space
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

citrascope-0.5.1/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.4
+Name: citrascope
+Version: 0.5.1
+Summary: Remotely control a telescope while it polls for tasks, collects and edge processes data, and delivers results and data for further processing.
+Author-email: Patrick McDavid <patrick@citra.space>
+License: MIT
+License-File: LICENSE
+Requires-Python: <3.13,>=3.10
+Requires-Dist: click
+Requires-Dist: fastapi>=0.104.0
+Requires-Dist: httpx
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: python-dateutil
+Requires-Dist: requests
+Requires-Dist: skyfield
+Requires-Dist: uvicorn[standard]>=0.24.0
+Requires-Dist: websockets>=12.0
+Provides-Extra: all
+Requires-Dist: dbus-python; extra == 'all'
+Requires-Dist: pixelemon; extra == 'all'
+Requires-Dist: plotly; extra == 'all'
+Requires-Dist: pyindi-client; extra == 'all'
+Provides-Extra: build
+Requires-Dist: build; extra == 'build'
+Provides-Extra: deploy
+Requires-Dist: twine; extra == 'deploy'
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: bump-my-version; extra == 'dev'
+Requires-Dist: flake8; extra == 'dev'
+Requires-Dist: flake8-pytest-style; extra == 'dev'
+Requires-Dist: isort; extra == 'dev'
+Requires-Dist: mockito; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: types-python-dateutil; extra == 'dev'
+Provides-Extra: indi
+Requires-Dist: pixelemon; extra == 'indi'
+Requires-Dist: plotly; extra == 'indi'
+Requires-Dist: pyindi-client; extra == 'indi'
+Provides-Extra: kstars
+Requires-Dist: dbus-python; extra == 'kstars'
+Provides-Extra: test
+Requires-Dist: mockito; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Description-Content-Type: text/markdown
+
+# CitraScope
+[![Pytest](https://github.com/citra-space/citrascope/actions/workflows/pytest.yml/badge.svg)](https://github.com/citra-space/citrascope/actions/workflows/pytest.yml) [![Publish Python Package](https://github.com/citra-space/citrascope/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/citra-space/citrascope/actions/workflows/pypi-publish.yml) [![PyPI version](https://badge.fury.io/py/citrascope.svg)](https://pypi.org/project/citrascope/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/citrascope)](https://pypi.org/project/citrascope/) [![License](https://img.shields.io/github/license/citra-space/citrascope)](https://github.com/citra-space/citrascope/blob/main/LICENSE)
+
+Remotely control a telescope while it polls for tasks, collects observations, and delivers data for further processing.
+
+## Features
+- Offers a web UI to configure hardware and connect to Citra.space's api
+- Connects to Citra.space's API and identifies itself as an online telescope
+- Connects to configured telescope and camera hardware
+- Acts as a task daemon carrying out and remitting photography tasks
+
+## Documentation
+
+Full documentation is available at [docs.citra.space](https://docs.citra.space/citrascope/).
+
+Documentation source is maintained in the [citra-space/docs](https://github.com/citra-space/docs) repository.
+
+## Installation
+
+**Important:** CitraScope requires Python 3.10, 3.11, or 3.12.
+
+### Check Your Python Version
+
+```sh
+python3 --version
+```
+
+If you don't have a compatible version, install one with [pyenv](https://github.com/pyenv/pyenv):
+
+```sh
+pyenv install 3.12.0
+pyenv local 3.12.0  # Sets Python 3.12.0 for the current directory
+```
+
+### Install CitraScope
+
+**Recommended: Using pip in a virtual environment**
+
+```sh
+python3 -m venv citrascope-env
+source citrascope-env/bin/activate  # On Windows: citrascope-env\Scripts\activate
+pip install citrascope
+```
+
+### Optional Dependencies
+
+For Linux-based telescope control (INDI):
+
+```sh
+pip install citrascope[indi]
+```
+
+This provides the `citrascope` command-line tool. To see available commands:
+
+```sh
+citrascope --help
+```
+
+## Usage
+
+### Starting the Daemon
+
+Run the daemon with:
+
+```sh
+citrascope
+```
+
+By default, this starts the web interface on `http://localhost:24872`. You can customize the port:
+
+```sh
+citrascope --web-port 8080
+```
+
+## Developer Setup
+
+If you are developing on macOS or Windows, use the provided [VS Code Dev Container](https://code.visualstudio.com/docs/devcontainers/containers) setup. The devcontainer provides a full Linux environment, which is required for the `pyindi-client` dependency to work. This is necessary because `pyindi-client` only works on Linux, and will not function natively on Mac or Windows.
+
+By opening this project in VS Code and choosing "Reopen in Container" (or using the Dev Containers extension), you can develop and run the project seamlessly, regardless of your host OS.
+
+The devcontainer also ensures all required system dependencies (like `cmake`) are installed automatically.
+
+### Python Version
+
+This project requires Python 3.10 or higher, up to Python 3.12. A `.python-version` file is included specifying Python 3.12 as the recommended version. If you use [pyenv](https://github.com/pyenv/pyenv), it will automatically use this version when you enter the project directory.
+
+### If not using the dev container:
+```sh
+python -m venv .venv
+source .venv/bin/activate
+```
+
+### Installing Development Dependencies
+
+To install development dependencies (for code style, linting, and pre-commit hooks):
+
+```sh
+pip install '.[dev]'
+```
+
+### Setting up Pre-commit Hooks
+
+This project uses [pre-commit](https://pre-commit.com/) to run code quality checks (like Flake8, Black, isort, etc.) automatically before each commit.
+
+After installing the dev dependencies, enable the hooks with:
+
+```sh
+pre-commit install
+```
+
+You can manually run all pre-commit checks on all files with:
+
+```sh
+pre-commit run --all-files
+```
+
+This ensures code style and quality checks are enforced for all contributors.
+
+### Releasing a New Version
+
+To bump the version and create a release:
+
+```sh
+bump-my-version bump patch  # 0.1.3 → 0.1.4
+bump-my-version bump minor  # 0.1.3 → 0.2.0
+bump-my-version bump major  # 0.1.3 → 1.0.0
+git push && git push --tags
+```
+
+Then create a release in the GitHub UI from the new tag. This triggers automatic PyPI publishing.
+
+### Running and Debugging with VS Code
+
+If you are using Visual Studio Code, you can run or debug the project directly using the pre-configured launch options in `.vscode/launch.json`:
+
+- **Python: citrascope** — Runs the daemon with default settings
+- **Python: citrascope (custom port)** — Runs with web interface on port 8080
+
+To use these, open the Run and Debug panel in VS Code, select the desired configuration, and click the Run or Debug button.
+
+## Running Tests
+
+This project uses [pytest](https://pytest.org/) for unit testing. All tests are located in the `tests/` directory.
+
+To run unit tests within your devcontainer:
+
+```bash
+pytest
+```