osu-data-csv 0.1.6
Downloads and Converts .sqls from data.ppy.sh into .csv
License: MIT
Requires Python: >=3.8,<4.0

# Data PPY CSV Retrieval

Retrieve data from the data ppy dump as CSV files.

# :exclamation: Important

I have been given permission to upload the script, however, not the data. 

Thus, if **you** want to upload the data elsewhere, please contact ppy through contact@ppy.sh.

```
All data provided here is done so with the intention of it being used for statistical analysis
and testing osu! subsystems.

Permission is NOT implicitly granted to deploy this in production use of any kind.
Should you wish to publicly use/expose the data provided here, please contact me first at contact@ppy.sh.

Please see https://github.com/ppy/osu-performance for more information.

Thanks,
ppy
```

## Downloading & Converting

1) `pip install osu-data-csv`
2) run `osu-data-csv` in the terminal
    ```bash
    osu-data-csv
    ```

    A series of prompts should show up. See **Arguments** below for more info and examples

3) (Alternatively) run in a single command

    ```bash
    osu-data-csv \
      -y "2022_12" \
      -d "mania" \
      -s "1000" \
      -l "data/" \
      -c "N" \
      -q "Y" \
      -i "path/to/ignore_mapping.yaml"
    ```

## Arguments

| Option           | Option (Shorthand) | Desc.                                                                  | Example                       |
|------------------|--------------------|------------------------------------------------------------------------|-------------------------------|
| --year_month     | -y                 | Dataset Year and Month. Will fail if doesn't exist anymore             | `2022_10`                     |
| --mode           | -d                 | Gamemode. ['catch', 'mania', 'osu', 'taiko']                           | `mania`                       |
| --set            | -s                 | Dataset of Top 1K or 10K players. ['1000', '10000']                    | `1000`                        |
| --dl_dir         | -l                 | Directory to download to. Best if empty. Can be not created.           | `data/`                       |
| --cleanup        | -c                 | Whether to delete unused files after conversion. ['Y', 'N']            | `N`                           |
| --bypass_confirm | -q                 | Whether to bypass confirmation of downloaded and new files. ['Y', 'N'] | `N`                           |
| --ignore_path    | -i                 | Path to YAML file ignore  specification (see next section)             | `path/to/ignore_mapping.yaml` |

It's set to retrieve the following:

```
osu_user_stats_<MODE>.sql
osu_scores_<MODE>_high.sql
osu_beatmap_difficulty.sql
osu_beatmaps.sql
```

### Selecting Columns

It's slow as it converts **all columns**. To speed this up, and reduce space taken, it's best to use `--ignore_path` 
with a YAML file.

1) [Download the template `ignore_mapping.yaml` here](ignore_mapping.yaml) 
2) Comment **out** fields that you want to **include**.
3) Call `osu-data-csv -i path/to/ignore_mapping.yaml [other options]`

For example
```yaml
osu_beatmap_difficulty.sql:
#  - beatmap_id
  - mode
  - mods
  - diff_unified
  - last_update
osu_beatmaps.sql:
  - beatmap_id
  - beatmapset_id
#  - user_id
#  - filename
...
```

We'll retrieve `beatmap_id` from `osu_beatmap_difficulty.sql` and `user_id`, `file_name` from `osu_beatmaps.sql` 

## Output

This will generate a few files. You'd want to retrieve the `.csv`.

```
- main.py 
- <dl_dir>/
  - 202X_XX_01_performance_<MODE>_top_<SET>.tar.bz2 (*)
  - 202X_XX_01_performance_<MODE>_top_<SET>/
    - csv/
      - osu_user_stats_<MODE>.csv
      - _.csv
      - ...
    - osu_user_stats_<MODE>.sql (*)
    - _.sql (*)
    - ...
```

- `(*)` files are deleted if `cleanup` is enabled.