citrascope 0.1.0

Remotely control a telescope while it polls for tasks, collects and edge processes data, and delivers results and data for further processing.

CitraScope

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:

pip install citrascope

This provides the citrascope command-line tool. To see available commands:

citrascope --help

Usage

Run the CLI tool:

citrascope start

To connect to the Citra Dev server:

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:

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 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):

pip install '.[dev]'

Setting up Pre-commit Hooks

This project uses pre-commit to run code quality checks (like Flake8, Black, isort, etc.) automatically before each commit.

After installing the dev dependencies, enable the hooks with:

pre-commit install

You can manually run all pre-commit checks on all files with:

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 for unit testing. All tests are located in the tests/ directory.

To run tests manually:

pytest