devmaxjasper commited on
Commit
7087be8
·
verified ·
1 Parent(s): 3bb30ca

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -24
README.md CHANGED
@@ -27,9 +27,9 @@ represents a playlist and includes high-level metadata (name, owner, follower
27
  count), cover image URLs, JSON payloads with the full Spotify response, and
28
  various bookkeeping columns (status, popularity histograms, history, etc.).
29
 
30
- The dataset ships as a ready-to-use CSV (`playlists.csv`, ~9 GB) along with the
31
- raw dump (`playlists_full.sql`, 27 GB) and a Python extractor script
32
- (`export_playlists_to_csv.py`) so anyone can regenerate the CSV from source.
33
 
34
  > ⚠️ **Attribution + ToS**: This dataset aggregates Spotify metadata originally
35
  > provided via their APIs. Redistribution is offered under CC BY 4.0, but you are
@@ -40,10 +40,11 @@ raw dump (`playlists_full.sql`, 27 GB) and a Python extractor script
40
 
41
  | Path | Description |
42
  | --- | --- |
43
- | `playlists_full.sql` | Original PostgreSQL dump (27 GB) containing `INSERT` statements for every table. |
44
- | `export_playlists_to_csv.py` | Streaming parser that extracts only `public.playlists` rows into CSV with progress reporting and batching. |
45
  | `playlists.csv` | Final 91,906-row CSV (17 columns, ~9 GB) with one playlist per row. |
46
- | `LICENSE` | CC BY 4.0 license text covering this dataset and helper scripts. |
 
 
 
47
 
48
  ## Schema
49
 
@@ -69,21 +70,9 @@ raw dump (`playlists_full.sql`, 27 GB) and a Python extractor script
69
 
70
  ## Regenerating the CSV
71
 
72
- ```bash
73
- python3 export_playlists_to_csv.py \
74
- --batch-size 2000 \
75
- --progress-interval 0.5
76
- ```
77
-
78
- Arguments:
79
-
80
- - `--batch-size` (default 2000): number of rows buffered before writing to CSV.
81
- - `--progress-interval` (default 0.25 seconds): how often to refresh the
82
- progress line.
83
-
84
- The script streams the SQL file, stops after the playlists table, and prints
85
- live progress (`rows`, `% of dump read`, and GiB consumed). It sets
86
- `csv.field_size_limit` to accommodate multi-megabyte JSON blobs.
87
 
88
  ## Loading the Dataset
89
 
@@ -108,7 +97,7 @@ chunked `pandas.read_csv(..., chunksize=10_000)`.
108
 
109
  1. **Create dataset repo**: `huggingface-cli repo create <namespace>/spotify-playlists-2025 --type dataset`.
110
  2. **Clone with Git LFS**: `GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/datasets/<namespace>/spotify-playlists-2025` then `cd` into it and run `git lfs install`.
111
- 3. **Copy assets**: Bring over `playlists.csv`, `export_playlists_to_csv.py`, `README.md`, and `LICENSE`.
112
  4. **Track large files**: `git lfs track "*.csv" "*.sql"`. Commit the updated `.gitattributes`.
113
  5. **Push**: `git add . && git commit -m "Add Spotify playlists dataset" && git push`.
114
  6. **Add metadata**: The `README.md` you are reading doubles as the Hugging Face dataset card, so it will render on the hub automatically.
@@ -119,7 +108,7 @@ you want to allow full reproducibility for others.
119
  ## License
120
 
121
  Creative Commons Attribution 4.0 International (CC BY 4.0). See `LICENSE` for
122
- the full text. When using the dataset, credit “Spotify Public Playlists (Oct 2025)”
123
  and include a link back to the Hugging Face dataset page or this repository.
124
 
125
  ## Citation
@@ -137,4 +126,4 @@ and include a link back to the Hugging Face dataset page or this repository.
137
  ## Contact
138
 
139
  Questions or takedown requests? Open an issue or reach out via the contact info
140
- on my Hugging Face profile.
 
27
  count), cover image URLs, JSON payloads with the full Spotify response, and
28
  various bookkeeping columns (status, popularity histograms, history, etc.).
29
 
30
+ The public release ships as a ready-to-use CSV (`playlists.csv`, ~9 GB) plus
31
+ supporting documentation. The original PostgreSQL dump and extractor script are
32
+ kept private but can be shared on request for verification purposes.
33
 
34
  > ⚠️ **Attribution + ToS**: This dataset aggregates Spotify metadata originally
35
  > provided via their APIs. Redistribution is offered under CC BY 4.0, but you are
 
40
 
41
  | Path | Description |
42
  | --- | --- |
 
 
43
  | `playlists.csv` | Final 91,906-row CSV (17 columns, ~9 GB) with one playlist per row. |
44
+ | `LICENSE` | CC BY 4.0 license text covering this dataset. |
45
+
46
+ > The original SQL dump and exporter script remain private. Contact the
47
+ > maintainer if you require the raw source data for verification.
48
 
49
  ## Schema
50
 
 
70
 
71
  ## Regenerating the CSV
72
 
73
+ The private repository includes an extraction script that streams the SQL dump,
74
+ filters the `public.playlists` table, and writes the CSV with progress
75
+ reporting and batching. Reach out if you need access to reproduce the export.
 
 
 
 
 
 
 
 
 
 
 
 
76
 
77
  ## Loading the Dataset
78
 
 
97
 
98
  1. **Create dataset repo**: `huggingface-cli repo create <namespace>/spotify-playlists-2025 --type dataset`.
99
  2. **Clone with Git LFS**: `GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/datasets/<namespace>/spotify-playlists-2025` then `cd` into it and run `git lfs install`.
100
+ 3. **Copy assets**: Bring over `playlists.csv`, `README.md`, and `LICENSE`.
101
  4. **Track large files**: `git lfs track "*.csv" "*.sql"`. Commit the updated `.gitattributes`.
102
  5. **Push**: `git add . && git commit -m "Add Spotify playlists dataset" && git push`.
103
  6. **Add metadata**: The `README.md` you are reading doubles as the Hugging Face dataset card, so it will render on the hub automatically.
 
108
  ## License
109
 
110
  Creative Commons Attribution 4.0 International (CC BY 4.0). See `LICENSE` for
111
+ the full text. When using the dataset, credit “Spotify Public Playlists (Nov 2025)”
112
  and include a link back to the Hugging Face dataset page or this repository.
113
 
114
  ## Citation
 
126
  ## Contact
127
 
128
  Questions or takedown requests? Open an issue or reach out via the contact info
129
+ on your Hugging Face profile.