moosicbox_admin_htmx 0.1.4

MoosicBox admin htmx package
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

# MoosicBox Admin HTMX

Basic HTMX API endpoints for administration functionality in MoosicBox.

## Overview

The MoosicBox Admin HTMX package provides:

- **API Endpoints**: Basic REST endpoints for administrative operations
- **Service Integration**: Interfaces with Qobuz and Tidal streaming services
- **Scan Management**: Library scan control and status endpoints
- **Info Retrieval**: System information and status endpoints

## Current Implementation

### Available API Modules
- **Scan API**: Control music library scanning operations
- **Info API**: Retrieve system and server information
- **Qobuz API**: Qobuz streaming service integration endpoints
- **Tidal API**: Tidal streaming service integration endpoints
- **Utilities**: Common API utilities and helpers

### Features
- **Library Scanning**: Trigger and monitor library scans
- **Service Status**: Check status of integrated streaming services
- **System Info**: Basic system information retrieval
- **Error Handling**: Structured error responses
- **HTMX Integration**: Designed to work with HTMX frontend requests

## Installation

### From Source

```bash
# Clone and build
git clone https://github.com/MoosicBox/MoosicBox.git
cd MoosicBox
cargo build --package moosicbox_admin_htmx
```

## Usage

### API Endpoints

The package provides REST API endpoints that can be integrated into a web server:

```rust
use moosicbox_admin_htmx::api;

// Example integration (actual web server setup depends on your framework)
// GET /admin/scan/status - Get scan status
// POST /admin/scan/start - Start library scan
// GET /admin/info - Get system info
// GET /admin/qobuz/status - Check Qobuz service status
// GET /admin/tidal/status - Check Tidal service status
```

### Scan Operations

```bash
# Check scan status
curl http://localhost:8000/admin/scan/status

# Start a library scan
curl -X POST http://localhost:8000/admin/scan/start

# Get scan progress
curl http://localhost:8000/admin/scan/progress
```

### Service Status

```bash
# Check Qobuz service status
curl http://localhost:8000/admin/qobuz/status

# Check Tidal service status
curl http://localhost:8000/admin/tidal/status

# Get system information
curl http://localhost:8000/admin/info
```

## Development

### Building

```bash
# Build the library
cargo build --package moosicbox_admin_htmx

# Build with API feature
cargo build --package moosicbox_admin_htmx --features api
```

### API Development

The package provides modular API endpoints:

```rust
use moosicbox_admin_htmx::api::{scan, info, qobuz, tidal};

// Endpoints are organized by functionality:
// - scan: Library scanning operations
// - info: System information
// - qobuz: Qobuz service integration
// - tidal: Tidal service integration
// - util: Common utilities
```

## Implementation Notes

- Currently provides API endpoints only (no web interface)
- Designed for HTMX frontend integration
- Modular structure allows selective feature usage
- Error handling follows standard HTTP response patterns
- Built with async/await support for non-blocking operations

## Future Development

The package is structured to support future expansion into:

- Full web administration interface
- User management functionality
- Configuration management
- Real-time status monitoring
- Dashboard implementation

## Contributing

To contribute to this package:

1. Focus on the API modules in `src/api/`
2. Follow the existing pattern for new endpoints
3. Ensure proper error handling and response formatting
4. Add tests for new functionality
5. Update documentation for new endpoints