citrascope 0.1.0__tar.gz

citrascope-0.1.0/.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.1.0/.env.example

@@ -0,0 +1,8 @@
+CITRASCOPE_PERSONAL_ACCESS_TOKEN=citra_pat_xxx
+CITRASCOPE_TELESCOPE_ID=xxx
+# CITRASCOPE_INDI_SERVER_URL=127.0.0.1
+# use host.docker.internal with devcontainer for accessing a localhost indi server
+CITRASCOPE_INDI_SERVER_URL=host.docker.internal
+CITRASCOPE_INDI_SERVER_PORT=7624
+CITRASCOPE_INDI_TELESCOPE_NAME=Telescope Simulator
+CITRASCOPE_INDI_CAMERA_NAME=CCD Simulator

citrascope-0.1.0/.flake8

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

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

@@ -0,0 +1,66 @@
+# 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/indi/`: INDI client integration
+- `citrascope/logging/`: Logging utilities
+- `citrascope/settings/`: Settings and configuration
+- `citrascope/tasks/`: Task runner and definitions
+- `tests/`: Unit and integration tests
+- `docs/`: Project documentation
+
+## 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 INDI client features in `citrascope/indi/`.
+- Update logging logic in `citrascope/logging/`.
+- Change settings in `citrascope/settings/`.
+- Add or modify tasks in `citrascope/tasks/`.
+- Write or update tests in `tests/`.
+
+## 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 start`) 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.
+
+For a complete list of dependencies, refer to the `pyproject.toml` file.
+
+## Additional Notes
+- Keep dependencies minimal and update `pyproject.toml` as needed.
+- Document any major changes in `docs/index.md`.
+- Use pre-commit hooks for code quality.

citrascope-0.1.0/.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.1.0/.github/workflows/docker-publish.yml

@@ -0,0 +1,29 @@
+name: Build and Push Docker Image
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push (multi-arch)
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/citrascope:latest

citrascope-0.1.0/.github/workflows/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.1.0/.github/workflows/pytest.yml

@@ -0,0 +1,32 @@
+name: Pytest
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - 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]
+      - name: Run pytest with coverage
+        run: |
+          pytest --cov=citrascope --cov-report=term-missing --cov-report=xml --cov-branch
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-xml
+          path: coverage.xml

citrascope-0.1.0/.gitignore

@@ -0,0 +1,143 @@
+# 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
+
+# Sphinx documentation
+docs/build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# 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

citrascope-0.1.0/.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.1.0/.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 dev start",
+            "type": "python",
+            "request": "launch",
+            "module": "citrascope",
+            "args": ["--dev", "start"],
+            "console": "integratedTerminal",
+            "justMyCode": false
+        },
+        {
+            "name": "Python: citrascope dev start DEBUG logging",
+            "type": "python",
+            "request": "launch",
+            "module": "citrascope",
+            "args": ["--dev", "--log-level", "DEBUG", "start"],
+            "console": "integratedTerminal",
+            "justMyCode": false
+        }
+    ]
+}

citrascope-0.1.0/Dockerfile

@@ -0,0 +1,30 @@
+# syntax=docker/dockerfile:1
+FROM python:3.12
+
+
+# Install system dependencies (match devcontainer setup)
+RUN apt-get update && \
+    apt-get install -y git cmake libdbus-1-dev libglib2.0-dev libjpeg-dev zlib1g-dev && \
+    rm -rf /var/lib/apt/lists/*
+
+# Set working directory
+WORKDIR /app
+
+
+# Copy local code into the image
+COPY . /app
+
+
+# Upgrade pip and install Python dependencies
+RUN python3 -m pip install --upgrade pip && pip install .
+
+# Environment variables (can be overridden at runtime)
+ENV CITRASCOPE_PERSONAL_ACCESS_TOKEN=""
+ENV CITRASCOPE_TELESCOPE_ID=""
+ENV CITRASCOPE_INDI_SERVER_URL="indi"
+ENV CITRASCOPE_INDI_TELESCOPE_NAME="Telescope Simulator"
+ENV CITRASCOPE_INDI_CAMERA_NAME="CCD Simulator"
+
+
+# Default command; can be overridden at runtime for flexibility
+CMD ["python3", "-m", "citrascope", "start"]

citrascope-0.1.0/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: citrascope
+Version: 0.1.0
+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: Christopher Stevens <chris@citra.space>
+License-Expression: MIT
+Requires-Python: >=3.9
+Requires-Dist: click
+Requires-Dist: httpx
+Requires-Dist: pixelemon
+Requires-Dist: pydantic-settings
+Requires-Dist: pyindi-client
+Requires-Dist: pytest-cov
+Requires-Dist: python-dateutil
+Requires-Dist: python-json-logger
+Requires-Dist: requests
+Requires-Dist: skyfield
+Requires-Dist: types-python-dateutil
+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: 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'
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
+Requires-Dist: sphinx-markdown-builder; extra == 'docs'
+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) [![Build and Push Docker Image](https://github.com/citra-space/citrascope/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/citra-space/citrascope/actions/workflows/docker-publish.yml)
+
+Remotely control a telescope while it polls for tasks, collects observations, and delivers data for further processing.
+
+## Features
+
+- Connects to Citra.space's API and identifies itself as an online telescope
+- Connects to configured INDI telescope and camera hardware
+- Acts as a task daemon carrying out and remitting photography tasks
+
+## Installation
+
+Install CitraScope from PyPI:
+
+```sh
+pip install citrascope
+```
+
+This provides the `citrascope` command-line tool. To see available commands:
+
+```sh
+citrascope --help
+```
+
+## Usage
+
+Run the CLI tool:
+
+```sh
+citrascope start
+```
+
+To connect to the Citra Dev server:
+
+```sh
+citrascope start --dev
+```
+
+## Configuration
+
+Settings are managed via environment variables with the prefix `CITRASCOPE_`. You must configure your personal access token and telescope ID, as well as INDI server details. You can set these variables in your shell or in a `.env` file at the project root.
+
+Example `.env` file:
+
+```env
+CITRASCOPE_PERSONAL_ACCESS_TOKEN=citra_pat_xxx
+CITRASCOPE_TELESCOPE_ID=xxx
+# CITRASCOPE_INDI_SERVER_URL=127.0.0.1
+CITRASCOPE_INDI_SERVER_URL=host.docker.internal  # use with devcontainer for accessing a localhost indi server
+CITRASCOPE_INDI_SERVER_PORT=7624
+CITRASCOPE_INDI_TELESCOPE_NAME=Telescope Simulator
+```
+
+**Variable descriptions:**
+
+- `CITRASCOPE_PERSONAL_ACCESS_TOKEN`: Your CitraScope personal access token (required)
+- `CITRASCOPE_TELESCOPE_ID`: Your telescope ID (required)
+- `CITRASCOPE_INDI_SERVER_URL`: Hostname or IP address of the INDI server (default: `host.docker.internal` for devcontainers, or `127.0.0.1` for local)
+- `CITRASCOPE_INDI_SERVER_PORT`: Port for the INDI server (default: `7624`)
+- `CITRASCOPE_INDI_TELESCOPE_NAME`: Name of the INDI telescope device (default: `Telescope Simulator`)
+
+You can copy `.env.example` to `.env` and tweak your values.
+
+## 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.
+
+### 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.
+
+### 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 dev start** — Runs the main entry point with development options.
+- **Python: citrascope dev start DEBUG logging** — Runs with development options and sets log level to DEBUG for more detailed output.
+
+To use these, open the Run and Debug panel in VS Code, select the desired configuration, and click the Run or Debug button. This is a convenient way to start or debug the app without manually entering commands.
+
+## Running Tests
+
+This project uses [pytest](https://pytest.org/) for unit testing. All tests are located in the `tests/` directory.
+
+To run tests manually:
+
+```bash
+pytest
+```