wax-dig 0.1.2

CLI for digging through public music discovery signals from Bandcamp and SoundCloud
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Platform {
    Bandcamp,
    Soundcloud,
}

impl Platform {
    pub fn as_str(self) -> &'static str {
        match self {
            Self::Bandcamp => "bandcamp",
            Self::Soundcloud => "soundcloud",
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum ItemKind {
    Album,
    Track,
    Playlist,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SeedAlbum {
    pub platform: Platform,
    pub kind: ItemKind,
    pub title: String,
    pub artist: String,
    pub url: String,
    pub artist_url: Option<String>,
    pub tags: Vec<String>,
    pub label: Option<String>,
    pub release_id: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Collector {
    pub handle: String,
    pub url: String,
    pub display_name: Option<String>,
    pub visible: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OwnedAlbum {
    pub platform: Platform,
    pub kind: ItemKind,
    pub title: String,
    pub artist: String,
    pub url: String,
    pub tags: Vec<String>,
    pub label: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CandidateRecord {
    pub rank: usize,
    pub title: String,
    pub artist: String,
    pub url: String,
    pub overlap_count: usize,
    pub overlap_ratio: f64,
    pub score: f64,
    pub reason: String,
    pub collectors: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CrawlSummary {
    pub collectors_discovered: usize,
    pub collectors_sampled: usize,
    pub collectors_scanned: usize,
    pub collectors_skipped: usize,
    pub candidates_ranked: usize,
    pub cache_hits: usize,
    pub cache_misses: usize,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ResolveOutput {
    pub seed: SeedAlbum,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CollectorsOutput {
    pub seed: SeedAlbum,
    pub collectors_discovered: usize,
    pub collectors: Vec<Collector>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LibraryOutput {
    pub collector_url: String,
    pub albums: Vec<OwnedAlbum>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DigOutput {
    pub seed: SeedAlbum,
    pub summary: CrawlSummary,
    pub results: Vec<CandidateRecord>,
}