citrascope 0.1.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

{citrascope-0.1.0.dist-info → citrascope-0.4.0.dist-info}/METADATA

@@ -1,27 +1,31 @@
 Metadata-Version: 2.4
 Name: citrascope
-Version: 0.1.0
+Version: 0.4.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>
+Author-email: Patrick McDavid <patrick@citra.space>
 License-Expression: MIT
-Requires-Python: >=3.9
+Requires-Python: <3.13,>=3.10
 Requires-Dist: click
+Requires-Dist: fastapi>=0.104.0
 Requires-Dist: httpx
-Requires-Dist: pixelemon
-Requires-Dist: pydantic-settings
-Requires-Dist: pyindi-client
-Requires-Dist: pytest-cov
+Requires-Dist: platformdirs>=4.0.0
 Requires-Dist: python-dateutil
-Requires-Dist: python-json-logger
 Requires-Dist: requests
 Requires-Dist: skyfield
-Requires-Dist: types-python-dateutil
+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'
@@ -30,10 +34,13 @@ 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'
+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'
@@ -41,68 +48,78 @@ 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)
+[![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)
 
 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 INDI telescope and camera hardware
+- 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
 
-Install CitraScope from PyPI:
+**Important:** CitraScope requires Python 3.10, 3.11, or 3.12.
+
+### Check Your Python Version
 
 ```sh
-pip install citrascope
+python3 --version
 ```
 
-This provides the `citrascope` command-line tool. To see available commands:
+If you don't have a compatible version, install one with [pyenv](https://github.com/pyenv/pyenv):
 
 ```sh
-citrascope --help
+pyenv install 3.12.0
+pyenv local 3.12.0  # Sets Python 3.12.0 for the current directory
 ```
 
-## Usage
+### Install CitraScope
 
-Run the CLI tool:
+**Recommended: Using pip in a virtual environment**
 
 ```sh
-citrascope start
+python3 -m venv citrascope-env
+source citrascope-env/bin/activate  # On Windows: citrascope-env\Scripts\activate
+pip install citrascope
 ```
 
-To connect to the Citra Dev server:
+### Optional Dependencies
+
+For Linux-based telescope control (INDI):
 
 ```sh
-citrascope start --dev
+pip install citrascope[indi]
 ```
 
-## Configuration
+This provides the `citrascope` command-line tool. To see available commands:
 
-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.
+```sh
+citrascope --help
+```
 
-Example `.env` file:
+## Usage
 
-```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
-```
+### Starting the Daemon
 
-**Variable descriptions:**
+Run the daemon with:
 
-- `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`)
+```sh
+citrascope
+```
 
-You can copy `.env.example` to `.env` and tweak your values.
+By default, this starts the web interface on `http://localhost:24872`. You can customize the port:
+
+```sh
+citrascope --web-port 8080
+```
 
 ## Developer Setup
 
@@ -112,6 +129,16 @@ By opening this project in VS Code and choosing "Reopen in Container" (or using
 
 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):
@@ -138,20 +165,33 @@ 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 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.
+- **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. This is a convenient way to start or debug the app without manually entering commands.
+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 tests manually:
+To run unit tests within your devcontainer:
 
 ```bash
 pytest

citrascope-0.4.0.dist-info/RECORD

@@ -0,0 +1,38 @@
+citrascope/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+citrascope/__main__.py,sha256=W7uY30MOuIlmhzVEoiZ_6BMmKrsqIvxcAxqw4-pOT3k,596
+citrascope/citra_scope_daemon.py,sha256=mw7U2gEgfDc3TuXVUHZAkHjSwY2T259FW02LAjz7vWU,10315
+citrascope/constants.py,sha256=Mc7SLzCelUMDV96BIwP684fFLGANCOEO_mM3GCeRDVY,968
+citrascope/api/abstract_api_client.py,sha256=gjmA9mw1O-TK16nYahOWClAwqPc_L1E3F2llZJeKTPw,624
+citrascope/api/citra_api_client.py,sha256=8rpz25Diy8YhuCiQ9HqMi4TIqxAc6BbrvqoFu8u-orQ,6007
+citrascope/hardware/abstract_astro_hardware_adapter.py,sha256=BdQrZkLSh2siszG8fGNEWpknC5wyZXZWgbaq7Zc7cAo,6131
+citrascope/hardware/adapter_registry.py,sha256=fFIZhXYphZ_p480c6hICpcx9fNOeX-EG2tvLHm372dM,3170
+citrascope/hardware/indi_adapter.py,sha256=uNrjkfxD0zjOPfar6J-frb6A87VkEjsL7SD9N9bEsC8,29903
+citrascope/hardware/kstars_dbus_adapter.py,sha256=Nv6ijVDvgTCTZUmRFh3Wh-YS7ChiztiXF17OWlzJwoo,7001
+citrascope/hardware/nina_adv_http_adapter.py,sha256=2McglZprEJQ8OKnqFXDrZCcl2AylkWO8Y1kGrS_nwtY,26261
+citrascope/hardware/nina_adv_http_survey_template.json,sha256=beg4H6Bzby-0x5uDc_eRJQ_rKs8VT64sDJyAzS_q1l4,14424
+citrascope/logging/__init__.py,sha256=YU38HLMWfbXh_H-s7W7Zx2pbCR4f_tRk7z0G8xqz4_o,179
+citrascope/logging/_citrascope_logger.py,sha256=GkqNpFJWiatqrBr8t4o2nHt7V9bBDJ8mysM0F4AXMa8,3479
+citrascope/logging/web_log_handler.py,sha256=d0XQzHJZ5M1v3H351tdkBYg7EOwFzXpp7PA9nYejIV0,2659
+citrascope/settings/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+citrascope/settings/citrascope_settings.py,sha256=yBDlM5uCnhUQgIrNDMTPX6cmgKnKl-lvra41-7XN40E,5966
+citrascope/settings/settings_file_manager.py,sha256=Yijb-I9hbbVJ2thkr7OrfkNknSPt1RDpsE7VvqAs0a8,4193
+citrascope/tasks/runner.py,sha256=xVnGWe_iYutBYqIhgOOriPjPcYUJ8IRbYRYKiAbehAQ,12584
+citrascope/tasks/task.py,sha256=0u0oN56E6KaNz19ba_7WuY43Sk4CTXc8UPT7sdUpRXo,1287
+citrascope/tasks/scope/base_telescope_task.py,sha256=wIdyUxplFNhf_YMdCXOK6pG7HF7tZn_id59TvYyWZAY,9674
+citrascope/tasks/scope/static_telescope_task.py,sha256=XP53zYVcyLHLvebDU06Jx0ghPK3tb0c_XmO60yj_XSA,1132
+citrascope/tasks/scope/tracking_telescope_task.py,sha256=k5LEmEi_xnFHNjqPNYb8_tqDdCFD3YGe25Wh_brJXHk,1130
+citrascope/web/__init__.py,sha256=CgU36fyNSxGXjUy3hsHwx7UxF8UO4Qsb7PjC9-6tRmY,38
+citrascope/web/app.py,sha256=OfBur9oM06NakrA30MOk9CgX0ewJ7IZl4kn0gtQgHJ4,20261
+citrascope/web/server.py,sha256=IJJk4HgEwcsjHercL-Q5z39NmJRbkNk_51HIUKKhtRE,5242
+citrascope/web/static/api.js,sha256=s-b1FIw-pTo3A8kLlLINVqHhIvfHwTWA7cEvz4N8Gqc,1924
+citrascope/web/static/app.js,sha256=xwKBzLB2uWytyUDdzrT6qsQBwIfESypjf8jSLnrQRZg,17820
+citrascope/web/static/config.js,sha256=4pjMH8yS24JkH62OpklEdPC0EAmd7e5c21WWETz1EO0,15701
+citrascope/web/static/style.css,sha256=haVMnKlULZ-SL_qmLyqnrwHdX28s6KzVK9uE_R5nlLo,2877
+citrascope/web/static/websocket.js,sha256=UITw1DDfehOKpjlltn5MXhewZYGKzPFmaTtMFtC0-Ps,3931
+citrascope/web/static/img/citra.png,sha256=Bq8dPWB6fNz7a_H0FuEtNmZWcPHH2iV2OC-fMg4REbQ,205570
+citrascope/web/static/img/favicon.png,sha256=zrbUlpFXDB_zmsIdhhn8_klnc2Ma3N6Q8ouBMAxFjbM,24873
+citrascope/web/templates/dashboard.html,sha256=4ChTsnMMP6VyfdQT9bM4rRruYHJorAeZFOMDhI-j3fA,24155
+citrascope-0.4.0.dist-info/METADATA,sha256=eombd_1rHdc9ubLY6PM7M2UKBqLMeT8aOQDUtqqWMP0,6481
+citrascope-0.4.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+citrascope-0.4.0.dist-info/entry_points.txt,sha256=fP22Lt8bNZ_whBowDnOWSADf_FUrgAWnIhqqPf5Xo2g,55
+citrascope-0.4.0.dist-info/RECORD,,

{citrascope-0.1.0.dist-info → citrascope-0.4.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

citrascope/settings/_citrascope_settings.py

@@ -1,42 +0,0 @@
-from pydantic_settings import BaseSettings, SettingsConfigDict
-
-from citrascope.logging import CITRASCOPE_LOGGER
-
-UNDEFINED_STRING = "undefined"
-
-
-class CitraScopeSettings(BaseSettings):
-    model_config = SettingsConfigDict(
-        env_prefix="CITRASCOPE_",
-        env_nested_delimiter="__",
-    )
-
-    # Default to production API
-    host: str = "api.citra.space"
-    port: int = 443
-
-    personal_access_token: str = UNDEFINED_STRING
-    use_ssl: bool = True
-    telescope_id: str = UNDEFINED_STRING
-
-    indi_server_url: str = "localhost"
-    indi_server_port: int = 7624
-    indi_telescope_name: str = UNDEFINED_STRING
-    indi_camera_name: str = UNDEFINED_STRING
-
-    log_level: str = "INFO"
-
-    def __init__(self, dev: bool = False, log_level: str = "INFO", **kwargs):
-        super().__init__(**kwargs)
-        self.log_level = log_level
-        if dev:
-            self.host = "dev.api.citra.space"
-            CITRASCOPE_LOGGER.info("Using development API endpoint.")
-
-    def model_post_init(self, __context) -> None:
-        if self.personal_access_token == UNDEFINED_STRING:
-            CITRASCOPE_LOGGER.warning(f"{self.__class__.__name__} personal_access_token has not been set")
-            exit(1)
-        if self.telescope_id == UNDEFINED_STRING:
-            CITRASCOPE_LOGGER.warning(f"{self.__class__.__name__} telescope_id has not been set")
-            exit(1)

citrascope-0.1.0.dist-info/RECORD

@@ -1,21 +0,0 @@
-citrascope/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-citrascope/__main__.py,sha256=MlIzMVRL_tnvd8vJcZXENIglepirST3KDPfVpN7V9bE,673
-citrascope/citra_scope_daemon.py,sha256=rQ4U7r2q5n9FSxM7E7xTdhpJjYCT7Mv_3PhUPkWwMTc,4073
-citrascope/api/abstract_api_client.py,sha256=FG386RwHZtsCNaGGx0bhwxajyj_0B6SxU3p2w0R4tYU,472
-citrascope/api/citra_api_client.py,sha256=7T7woGN-cjTYF8CNkGSjWXCKO-q0ufnBLGrdT2pdY3w,4173
-citrascope/hardware/abstract_astro_hardware_adapter.py,sha256=JOw0PDoFrgicB5qZrurlLrVcDsjQNjHcxyFJ6674KJ8,3748
-citrascope/hardware/indi_adapter.py,sha256=57AvH-AzthqXyefUgMq21GfcFfNh9WcGoara03NiJkg,12564
-citrascope/logging/__init__.py,sha256=bXX2PX6MZelEX3fi_-lmT51uZCfN9WnLPZfx5_RswAA,101
-citrascope/logging/_citrascope_logger.py,sha256=-KZ3ufQc3VOSlP1I3KC1YFDU7o880-O0iu3URlzRGlM,1056
-citrascope/settings/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-citrascope/settings/_citrascope_settings.py,sha256=JpuVFroZERPjbx58ZCw9BM9xr41qW6MNxm3sYGjYS14,1386
-citrascope/tasks/runner.py,sha256=pUyQlrQkSNbM_SKl6AUFY8QSV2NzZfGvybGlzV7Q-BU,7320
-citrascope/tasks/task.py,sha256=0u0oN56E6KaNz19ba_7WuY43Sk4CTXc8UPT7sdUpRXo,1287
-citrascope/tasks/scope/base_telescope_task.py,sha256=He8W9OSHDL2tp56sY5dPdtYDswzp5HDMMeWpSNYNcgY,9198
-citrascope/tasks/scope/static_telescope_task.py,sha256=DTrKZiOJ3ZPSDPvmMbyWkW50kS4I6Li6qC6SyrpWbaI,612
-citrascope/tasks/scope/tracking_telescope_task.py,sha256=k5LEmEi_xnFHNjqPNYb8_tqDdCFD3YGe25Wh_brJXHk,1130
-docs/index.md,sha256=YQDeVrN9AcbRzo88Jc4iRCO70gAh_4GSgImrJMwcSCo,1402
-citrascope-0.1.0.dist-info/METADATA,sha256=u7Uc7lN6PZz78TUNFqmYe3IWBgxPdfudIpg31kuuVX0,5817
-citrascope-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-citrascope-0.1.0.dist-info/entry_points.txt,sha256=fP22Lt8bNZ_whBowDnOWSADf_FUrgAWnIhqqPf5Xo2g,55
-citrascope-0.1.0.dist-info/RECORD,,

docs/index.md

@@ -1,47 +0,0 @@
-# CitraScope Documentation
-
-Welcome to the CitraScope documentation.
-
-## Overview
-
-CitraScope is a Python application for remote telescope control, task automation, and data collection.
-It connects to the Citra.space API and INDI hardware to execute observation tasks.
-
-## Architecture
-
-- **CLI Entrypoint:** `citrascope/__main__.py`
-  Handles configuration, authentication, and starts the task daemon.
-- **API Client:** `citrascope/api/client.py`
-  Communicates with Citra.space for authentication, telescope, satellite, and ground station data.
-- **Task Management:** `citrascope/tasks/runner.py`
-  Polls for tasks, schedules, and executes observations.
-- **Settings:** `citrascope/settings/_citrascope_settings.py`
-  Loads configuration from environment variables.
-
-## Configuration
-
-See [README.md](../README.md) for installation and environment setup.
-Environment variables are documented in `.env.example`.
-
-## Usage
-
-Run the CLI:
-```sh
-python -m citrascope start
-```
-Or use VS Code launch configurations for development and debugging.
-
-## Testing
-
-- **Unit tests** are written using [pytest](https://pytest.org/) and are located in the `tests/` directory.
-- To run tests manually, use:
-
-  ```bash
-  pytest
-  ```
-
-## Further Documentation
-
-- [API Reference](https://api.citra.space/docs)
-- [Contributing Guide](contributing.md) (coming soon)
-- [Troubleshooting](troubleshooting.md) (coming soon)