Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #229

Merged
merged 3 commits into from
Jan 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 42 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,55 @@
# NOLPL Stats: Latest statistics about *N'oubliez Pas Les Paroles*
# NOPLP Stats: Latest statistics about *N'oubliez Pas Les Paroles*

Python project to exploit and present lastest data about NOPLP from dedicated [Fandom Wiki](https://n-oubliez-pas-les-paroles.fandom.com/fr/).
## About this app

Python project to exploit and present lastest statistics and data about NOPLP from dedicated [Fandom Wiki](https://n-oubliez-pas-les-paroles.fandom.com/fr/).

See the app here: [https://noplp-stats.oa.r.appspot.com/](https://noplp-stats.oa.r.appspot.com/).

## What can I find?

General statistics about *N'oubliez Pas Les Paroles*, including:

* Most popular songs (choose top list size and timeframe)
* Coverage scores: "If I knew those N songs, I would have been able to score x % of the time."
* Coverage scores: number of songs to know a whole category!
* Singer and song specific stats:
* Songs ranking for each singer
* Graph of all occurrences of a song
* NOPLP Fandom lyrics, checked on the show (when available)
* Training playground: write the song lyrics to learn them or check your knowledge (match against NOPLP Fandom lyrics)

Using Python 3.10
## Screenshots

### Global statistics page

* Most popular songs on specific time window
* Top 10, 20, 50, etc.

![Global statistics page](docs/noplp-stats-global.png)

### Song statistics page

* Most popular song ranking in each category (Points, Maestro, Même chanson, etc.)
* Dot chart of song occurences in the show
* Song lyrics, based on the [Fandom Wiki](https://n-oubliez-pas-les-paroles.fandom.com/fr/) lyrics, **verified on the show when written in bold**

![Song statistics page](docs/noplp-stats-song.png)

### Singer statistics page

* All songs of the same singer, sorted by popularity on the show!
* Dot chart of all songs occurences in the show, for the given singer

![Singer statistics page](docs/noplp-stats-singer.png)

### Training page

* You think you remember the lyrics? Check your knwoledge of a song on the training page!
* Song lyrics based on the [Fandom Wiki](https://n-oubliez-pas-les-paroles.fandom.com/fr/) lyrics, **verified on the show when written in bold!**

![Singer statistics page](docs/noplp-stats-singer.png)

## License

The data, from [Fandom Wiki](https://n-oubliez-pas-les-paroles.fandom.com/fr/), is under CC-BY-SA license.
The web app code is under MIT license.
Binary file added docs/noplp-stats-global.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/noplp-stats-singer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/noplp-stats-song.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/noplp-stats-training.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading