citrascope 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- citrascope/__init__.py +0 -0
- citrascope/__main__.py +23 -0
- citrascope/api/abstract_api_client.py +23 -0
- citrascope/api/citra_api_client.py +101 -0
- citrascope/citra_scope_daemon.py +90 -0
- citrascope/hardware/abstract_astro_hardware_adapter.py +110 -0
- citrascope/hardware/indi_adapter.py +290 -0
- citrascope/logging/__init__.py +3 -0
- citrascope/logging/_citrascope_logger.py +35 -0
- citrascope/settings/__init__.py +0 -0
- citrascope/settings/_citrascope_settings.py +42 -0
- citrascope/tasks/runner.py +156 -0
- citrascope/tasks/scope/base_telescope_task.py +205 -0
- citrascope/tasks/scope/static_telescope_task.py +16 -0
- citrascope/tasks/scope/tracking_telescope_task.py +28 -0
- citrascope/tasks/task.py +43 -0
- citrascope-0.1.0.dist-info/METADATA +158 -0
- citrascope-0.1.0.dist-info/RECORD +21 -0
- citrascope-0.1.0.dist-info/WHEEL +4 -0
- citrascope-0.1.0.dist-info/entry_points.txt +2 -0
- docs/index.md +47 -0
docs/index.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# CitraScope Documentation
|
|
2
|
+
|
|
3
|
+
Welcome to the CitraScope documentation.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
CitraScope is a Python application for remote telescope control, task automation, and data collection.
|
|
8
|
+
It connects to the Citra.space API and INDI hardware to execute observation tasks.
|
|
9
|
+
|
|
10
|
+
## Architecture
|
|
11
|
+
|
|
12
|
+
- **CLI Entrypoint:** `citrascope/__main__.py`
|
|
13
|
+
Handles configuration, authentication, and starts the task daemon.
|
|
14
|
+
- **API Client:** `citrascope/api/client.py`
|
|
15
|
+
Communicates with Citra.space for authentication, telescope, satellite, and ground station data.
|
|
16
|
+
- **Task Management:** `citrascope/tasks/runner.py`
|
|
17
|
+
Polls for tasks, schedules, and executes observations.
|
|
18
|
+
- **Settings:** `citrascope/settings/_citrascope_settings.py`
|
|
19
|
+
Loads configuration from environment variables.
|
|
20
|
+
|
|
21
|
+
## Configuration
|
|
22
|
+
|
|
23
|
+
See [README.md](../README.md) for installation and environment setup.
|
|
24
|
+
Environment variables are documented in `.env.example`.
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
Run the CLI:
|
|
29
|
+
```sh
|
|
30
|
+
python -m citrascope start
|
|
31
|
+
```
|
|
32
|
+
Or use VS Code launch configurations for development and debugging.
|
|
33
|
+
|
|
34
|
+
## Testing
|
|
35
|
+
|
|
36
|
+
- **Unit tests** are written using [pytest](https://pytest.org/) and are located in the `tests/` directory.
|
|
37
|
+
- To run tests manually, use:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
pytest
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Further Documentation
|
|
44
|
+
|
|
45
|
+
- [API Reference](https://api.citra.space/docs)
|
|
46
|
+
- [Contributing Guide](contributing.md) (coming soon)
|
|
47
|
+
- [Troubleshooting](troubleshooting.md) (coming soon)
|