wrapperr/README.md

# Plex Wrapped
## Introduction

A website-based platform and API for collecting Plex user stats within a set timeframe using [Tautulli](https://github.com/Tautulli/Tautulli). The data is displayed as a stat-summary, sort of like Spotify Wrapped. Yes, you need Tautulli to have been running beforehand and currently for this to work.

![alt text](https://raw.githubusercontent.com/aunefyren/Plex-Wrapped/main/assets/img/example_01.PNG?raw=true)

### Features
- Custom timeframes
- Caching of results
- Friendly, dynamic display for statistics with nice illustrations
- Email and username search
- Admin page with authentication for settings
- Pre-caching of user-sets

![alt text](https://raw.githubusercontent.com/aunefyren/Plex-Wrapped/main/assets/img/example_02.PNG?raw=true)

### Credit
- Beautiful illustrations downloaded from https://freewebillustrations.com/
- Amazing statistics gathered using [Tautulli](https://github.com/Tautulli/Tautulli)
- Wonderful loading icon from [icons8](https://icons8.com/preloaders/en/miscellaneous/hourglass/)

![alt text](https://raw.githubusercontent.com/aunefyren/Plex-Wrapped/main/assets/img/example_03.PNG?raw=true)

## Instructions
This is a web-based platform. Place it in a webserver like Apache or Nginx and make sure it processes PHP content.

There are multiple settings you must configure! They will be stored in config/config.json, but can be configured easily at <b>you-domain-or-ip/admin.html</b>.

PHP will have issues with this API based on the results you want. If you have a large time frame for your wrapped period and there is a huge amount of Tautulli entries you can have multiple issues.
In your php.ini file you may have to change:
- max_execution_time=<b>enough seconds for the script to finish</b>
- memory_limit=<b>enough M for the script to handle JSON data</b>
- max_input_time=<b>enough seconds for the script to parse JSON data</b>

You need to give PHP permission to edit files in the directory called <b>config</b>.

The cache is stored at config/cache.json, but can be cleared using the admin menu.

Your password is stored hashed in the config.json.

If you visit <b>you-domain-or-ip/caching.html</b> you can do a pre-caching of a set of users. This is very useful if you want to prepare for a lot of traffic.

## Need help?
If you have any issues feel free to contact me. I am always trying to improve the project. If I can't, many people on several forums (including /r/plex) might be able to assist you.

<b>Goodybye.</b>
Fixed merge error Fixed merge error during last update. Read.me is correct and Jquery is back. 2020-12-22 16:41:46 +00:00			`# Plex Wrapped`
Caching, admin page, username search, flexible results - New design for platform - Page change based on results - Illustrations added - Search by email and username - Better security (sensitive files moved to folder with .htaccess) - Admin page for setup (with password) - Customizable functions - Caching of results - Pre-caching script for caching multiple users 2021-03-08 18:45:06 +00:00			`## Introduction`
Managed to push my own settings :) God damn 2021-05-16 12:08:33 +00:00
Changed category-titles and fixed typo in readme The titles needed a proper context to make sense. If other categories were disabled they made little sense. 2021-08-11 16:07:05 +00:00			`A website-based platform and API for collecting Plex user stats within a set timeframe using [Tautulli](https://github.com/Tautulli/Tautulli). The data is displayed as a stat-summary, sort of like Spotify Wrapped. Yes, you need Tautulli to have been running beforehand and currently for this to work.`
Managed to push my own settings :) God damn 2021-05-16 12:08:33 +00:00
			`![alt text](https://raw.githubusercontent.com/aunefyren/Plex-Wrapped/main/assets/img/example_01.PNG?raw=true)`

			`### Features`
			`- Custom timeframes`
			`- Caching of results`
			`- Friendly, dynamic display for statistics with nice illustrations`
			`- Email and username search`
			`- Admin page with authentication for settings`
Changed category-titles and fixed typo in readme The titles needed a proper context to make sense. If other categories were disabled they made little sense. 2021-08-11 16:07:05 +00:00			`- Pre-caching of user-sets`
Managed to push my own settings :) God damn 2021-05-16 12:08:33 +00:00
			`![alt text](https://raw.githubusercontent.com/aunefyren/Plex-Wrapped/main/assets/img/example_02.PNG?raw=true)`

			`### Credit`
			`- Beautiful illustrations downloaded from https://freewebillustrations.com/`
			`- Amazing statistics gathered using [Tautulli](https://github.com/Tautulli/Tautulli)`
Changed category-titles and fixed typo in readme The titles needed a proper context to make sense. If other categories were disabled they made little sense. 2021-08-11 16:07:05 +00:00			`- Wonderful loading icon from [icons8](https://icons8.com/preloaders/en/miscellaneous/hourglass/)`
Managed to push my own settings :) God damn 2021-05-16 12:08:33 +00:00
			`![alt text](https://raw.githubusercontent.com/aunefyren/Plex-Wrapped/main/assets/img/example_03.PNG?raw=true)`

First version The first version of my script, modified to remove sensetive information. 2020-12-19 16:10:59 +00:00			`## Instructions`
More details in readme and CSS improvements README now explains what do to with the project and the stats-page now stacks better. 2021-03-09 23:41:48 +00:00			`This is a web-based platform. Place it in a webserver like Apache or Nginx and make sure it processes PHP content.`
Fixed merge error Fixed merge error during last update. Read.me is correct and Jquery is back. 2020-12-22 16:41:46 +00:00
Caching of server-wide stats improved, fixed merging error Had a lot of issues with the last merger and might have lost some changes. This build is functional. 2021-08-11 15:34:25 +00:00			`There are multiple settings you must configure! They will be stored in config/config.json, but can be configured easily at <b>you-domain-or-ip/admin.html</b>.`
Fixed merge error Fixed merge error during last update. Read.me is correct and Jquery is back. 2020-12-22 16:41:46 +00:00
Caching, admin page, username search, flexible results - New design for platform - Page change based on results - Illustrations added - Search by email and username - Better security (sensitive files moved to folder with .htaccess) - Admin page for setup (with password) - Customizable functions - Caching of results - Pre-caching script for caching multiple users 2021-03-08 18:45:06 +00:00			`PHP will have issues with this API based on the results you want. If you have a large time frame for your wrapped period and there is a huge amount of Tautulli entries you can have multiple issues.`
			`In your php.ini file you may have to change:`
			`- max_execution_time=<b>enough seconds for the script to finish</b>`
			`- memory_limit=<b>enough M for the script to handle JSON data</b>`
			`- max_input_time=<b>enough seconds for the script to parse JSON data</b>`
First version The first version of my script, modified to remove sensetive information. 2020-12-19 16:10:59 +00:00
Caching of server-wide stats improved, fixed merging error Had a lot of issues with the last merger and might have lost some changes. This build is functional. 2021-08-11 15:34:25 +00:00			`You need to give PHP permission to edit files in the directory called <b>config</b>.`
CSS fix and more PHP instructions Added tips to give PHP directory access and removed duplicate CSS line and CSS width. 2021-03-09 15:53:43 +00:00
Caching, admin page, username search, flexible results - New design for platform - Page change based on results - Illustrations added - Search by email and username - Better security (sensitive files moved to folder with .htaccess) - Admin page for setup (with password) - Customizable functions - Caching of results - Pre-caching script for caching multiple users 2021-03-08 18:45:06 +00:00			`The cache is stored at config/cache.json, but can be cleared using the admin menu.`
More stats, CSS fixes, GET-url support CSS fixed up a bit, but still a bit messy. API now gives more stats, like oldest movie, and the website calculates spent time watching content. API file supports GET values in URL, but prioritizes POST if both are recieved. 2020-12-23 13:17:10 +00:00
Changed category-titles and fixed typo in readme The titles needed a proper context to make sense. If other categories were disabled they made little sense. 2021-08-11 16:07:05 +00:00			`Your password is stored hashed in the config.json.`

Caching of server-wide stats improved, fixed merging error Had a lot of issues with the last merger and might have lost some changes. This build is functional. 2021-08-11 15:34:25 +00:00			`If you visit <b>you-domain-or-ip/caching.html</b> you can do a pre-caching of a set of users. This is very useful if you want to prepare for a lot of traffic.`
More stats, CSS fixes, GET-url support CSS fixed up a bit, but still a bit messy. API now gives more stats, like oldest movie, and the website calculates spent time watching content. API file supports GET values in URL, but prioritizes POST if both are recieved. 2020-12-23 13:17:10 +00:00
First version The first version of my script, modified to remove sensetive information. 2020-12-19 16:10:59 +00:00			`## Need help?`
Caching, admin page, username search, flexible results - New design for platform - Page change based on results - Illustrations added - Search by email and username - Better security (sensitive files moved to folder with .htaccess) - Admin page for setup (with password) - Customizable functions - Caching of results - Pre-caching script for caching multiple users 2021-03-08 18:45:06 +00:00			`If you have any issues feel free to contact me. I am always trying to improve the project. If I can't, many people on several forums (including /r/plex) might be able to assist you.`
First version The first version of my script, modified to remove sensetive information. 2020-12-19 16:10:59 +00:00
Minor Readme error 2021-05-16 11:58:03 +00:00			`<b>Goodybye.</b>`