📚 docs: add missing READMEs and align crates with Rust rules

- Create README.md for paracas-daemon and paracas-estimate
- Add #![doc = include_str!("../README.md")] to daemon/estimate lib.rs
- Add missing Cargo.toml metadata (docs.rs, authors, keywords, categories)
- Reorder workspace dependencies by line length per style guide
- Document background jobs, download-all, status, and job commands
This commit is contained in:
Andreas Bigger
2025-12-29 18:02:56 -05:00
parent 559171956e
commit 3edf2d9ece
10 changed files with 201 additions and 10 deletions
+57
View File
@@ -20,6 +20,21 @@ paracas download eurusd -s 2024-01-01 -e 2024-01-31 -o data.csv
# Download as Parquet with 1-hour aggregation
paracas download btcusd -s 2024-01-01 -e 2024-12-31 -o data.parquet -f parquet -t h1
# Download in background
paracas download eurusd -s 2024-01-01 -e 2024-12-31 --background
```
### Download All
Download all instruments (or filter by category):
```bash
# Download all forex instruments
paracas download-all --category forex -o ./data/
# Download all crypto as Parquet in background
paracas download-all --category crypto -f parquet --background
```
### List
@@ -45,6 +60,48 @@ Show instrument details:
paracas info eurusd
```
### Status
Check background job status:
```bash
# Show all jobs
paracas status --all
# Show only running jobs
paracas status --running
# Check specific job
paracas status <job-id>
# Watch mode (refresh every 5 seconds)
paracas status --follow 5
# Cancel a running job
paracas status --cancel <job-id>
```
### Job
Manage background jobs:
```bash
# Pause a running job
paracas job pause <job-id>
# Resume a paused job
paracas job resume <job-id>
# Kill a running or paused job
paracas job kill <job-id>
# Clean up finished jobs
paracas job clean
# Clean all finished jobs
paracas job clean --all
```
## License
MIT License - see [LICENSE](../LICENSE) for details.