mirror of
https://github.com/agresdominik/predictify.git
synced 2026-04-21 17:55:49 +00:00
Add documentation for docker and small visual improvements
This commit is contained in:
@@ -11,15 +11,43 @@ A Data analysis tool to scrape your Spotify History usage and let a ML-Model pre
|
|||||||
|
|
||||||
## Usable possible APIs
|
## Usable possible APIs
|
||||||
|
|
||||||
Recently Played Tracks: /me/player/recently-played [Official Spotify Documentation](https://developer.spotify.com/documentation/web-api/reference/get-recently-played)
|
Recently Played Tracks: `/me/player/recently-played` [Official Spotify Documentation](https://developer.spotify.com/documentation/web-api/reference/get-recently-played)
|
||||||
|
|
||||||
Get Track: /tracks/{id} [Official Spotify Documentation](https://developer.spotify.com/documentation/web-api/reference/get-track)
|
Get Track: `/tracks/{id}` [Official Spotify Documentation](https://developer.spotify.com/documentation/web-api/reference/get-track)
|
||||||
|
|
||||||
Get Track's Audio Features - Deprecated: /audio-features/{id} [Official Spotify Documentation](https://developer.spotify.com/documentation/web-api/reference/get-audio-features)
|
Get Track's Audio Features _(Deprecated)_: `/audio-features/{id}` [Official Spotify Documentation](https://developer.spotify.com/documentation/web-api/reference/get-audio-features)
|
||||||
|
|
||||||
Get Track's Audio Analysis - Deprecated: /audio-analysis/{id} [Official Spotify Documentation](https://developer.spotify.com/documentation/web-api/reference/get-audio-analysis)
|
Get Track's Audio Analysis _(Deprecated)_: `/audio-analysis/{id}` [Official Spotify Documentation](https://developer.spotify.com/documentation/web-api/reference/get-audio-analysis)
|
||||||
|
|
||||||
Get Artist: /artists/{id} [Official Spotify Documentation](https://developer.spotify.com/documentation/web-api/reference/get-an-artist)
|
Get Artist: `/artists/{id}` [Official Spotify Documentation](https://developer.spotify.com/documentation/web-api/reference/get-an-artist)
|
||||||
|
|
||||||
|
## Docker usage
|
||||||
|
|
||||||
|
`cd` inside the projects directory:
|
||||||
|
```sh
|
||||||
|
cd predictify
|
||||||
|
```
|
||||||
|
To run predictify inside a container, first make sure to build the image:
|
||||||
|
```sh
|
||||||
|
make dockerfile
|
||||||
|
```
|
||||||
|
> [!NOTE]
|
||||||
|
>
|
||||||
|
Create a seperate data directory (e.g. `docker-data`):
|
||||||
|
```sh
|
||||||
|
mkdir docker-data
|
||||||
|
```
|
||||||
|
> [!NOTE]
|
||||||
|
> To detatch the container to run it in the background add the `--detach` directly after the `run` command.
|
||||||
|
Then run the following docker command, to run the container in the foreground:
|
||||||
|
```sh
|
||||||
|
docker run \
|
||||||
|
--name predictify \
|
||||||
|
--network=host \
|
||||||
|
--volume $(pwd)/data-docker:/app/predictify/data \
|
||||||
|
--volume $(pwd)/config:/app/predictify/config \
|
||||||
|
predictify:unstable
|
||||||
|
```
|
||||||
|
|
||||||
## Authors
|
## Authors
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user