📚 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
+9 -1
View File
@@ -1,16 +1,24 @@
[package]
name = "paracas-estimate"
description = "Download size and time estimation for paracas tick data downloader"
version.workspace = true
edition.workspace = true
rust-version.workspace = true
license.workspace = true
homepage.workspace = true
repository.workspace = true
description = "Download size and time estimation for paracas tick data downloader"
documentation.workspace = true
authors.workspace = true
keywords.workspace = true
categories.workspace = true
[lints]
workspace = true
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
paracas-types = { workspace = true }
serde = { workspace = true }
+39
View File
@@ -0,0 +1,39 @@
# paracas-estimate
Download size and time estimation for the paracas tick data downloader.
## Features
- Historical size estimates per instrument category
- Download time estimation based on data volume
- Confidence levels for estimates
## Types
- `EstimateDatabase` - Database of historical size estimates per category
- `CategoryEstimate` - Size estimates for a single category
- `Estimator` - Computes download estimates for instruments and date ranges
- `DownloadEstimate` - Estimated download metrics
- `EstimateConfidence` - Confidence level of the estimate
## Usage
```rust,ignore
use paracas_estimate::{Estimator, EstimateDatabase};
use paracas_types::{Category, DateRange};
// Create an estimator with the default database
let db = EstimateDatabase::default();
let estimator = Estimator::new(&db);
// Estimate download for a date range
let range = DateRange::new(start, end)?;
let estimate = estimator.estimate(Category::Forex, &range);
println!("Estimated size: {} bytes", estimate.size_bytes);
println!("Confidence: {:?}", estimate.confidence);
```
## License
MIT License - see [LICENSE](../../LICENSE) for details.
+1
View File
@@ -9,6 +9,7 @@
//! - [`DownloadEstimate`] - Estimated download metrics
//! - [`EstimateConfidence`] - Confidence level of the estimate
#![doc = include_str!("../README.md")]
#![doc(issue_tracker_base_url = "https://github.com/factordynamics/paracas/issues/")]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
#![warn(missing_docs)]