A Python script to help you select the movies you want to record with your Freebox
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

77 lines
3.8 KiB

2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
  1. FreeboxMoviePlanner
  2. ===
  3. A few words in English
  4. ---
  5. A Python script to help you select the movies you want to record with your Freebox, provided by Free, a french ISP. As such, the rest of this Readme will be in French.
  6. Introduction
  7. ---
  8. **FreeMoviePlanner** est un outil qui vous facilite la plannification
  9. d'enregistrements avec votre *Freebox*.
  10. Concrètement, l'outil effectue les opérations suivantes :
  11. * Récupérer les film de la semaine à partir du [planning *Télé 7 Jours*](https://www.programme-television.org/?bouquet=free)
  12. * Retirer les chaînes auxquelles vous n'avez pas accès
  13. * Trouver les notes des films sur [*TMDb*](https://www.themoviedb.org/) (*The Movie Database*)
  14. * Exclure les films en dessous d'une certaine note (paramétrable)
  15. * Afficher les résumés des films et vous demander de sélectionner ceux qui vous intéressent.
  16. * Planifier les enregistrements sur votre *Freebox*.
  17. * Vous prévenir si des conflits sont identifiés pour que vous les résolviez depuis l'interface de votre *Freebox*.
  18. ![FreeboxMoviePlanner en action](https://djib.fr/djib/FreeboxMoviePlanner/raw/branch/master/screenshot.png)
  19. Installation
  20. ---
  21. ### À partir de l'exécutable
  22. [Téléchargez](https://djib.fr/djib/FreeboxMoviePlanner/releases) le fichier qui correspond à votre système d'exploitation (Linux ou Windows).
  23. Extrayez ensuite ce fichier à l'emplacement de votre choix.
  24. ### À partir des sources
  25. Pour utiliser **FreeboxMoviePlanner** à partir des sources, il vous faut Python, ainsi que les 3 packages suivants (à installer par exemple avec `pip install [nom du packet]`) :
  26. * `beautifulsoup4`
  27. * `tmdbsimple`
  28. * `zeroconf`
  29. Il vous faut ensuite récupérer le code du projet, le plus simple étant en clonant le dépôt git.
  30. ```bash
  31. git clone --recurse-submodules https://djib.fr/djib/FreeboxMoviePlanner.git
  32. ```
  33. Configuration
  34. ---
  35. Ensuite, il vous faut créer un fichier de conf `config.json`. Vous pouvez tout simplement renommer le fichier `config.template.json`.
  36. Dans ce fichier vous devrez renseigner une clef API TMDb. Pour cela vous aurez besoin d'[ouvrir un compte](https://www.themoviedb.org/account/signup) sur leur site et de [demander une clef API](https://www.themoviedb.org/settings/api).
  37. Le fichier de config vous permet aussi de configurer la marge avant et après chaque enregistrement, ou la note en dessous de laquelle les films ne s'afficheront pas.
  38. Exécution
  39. ---
  40. L'outil devrait vous afficher rapidement le petit texte `Working the magic, please wait…` puis, après environ une minute (ou plus si votre réseau est lent), le détail des films.
  41. À la première exécution, l'outil vous demandera aussi d'autoriser le script sur votre Freebox (`Please go to your Freebox and accept the authentication.`)
  42. À ce moment, l'affichage de votre boîtier *Freebox* vous demandera de valider cette demande d'authentification. Vous devez donc physiquement valider l'accès à partir de votre box (sur la V6, il s'agit de presser la flèche de droite).
  43. Notez que les films de *Canal+* s'afficheront par défaut. La *Freebox* indique que la chaîne est disponible, probablement car elle est parfois visible en clair. Vous pouvez forcer son exclusion avec le paramètre `-e Canal+`.
  44. Enjoy!
  45. Documentation
  46. ---
  47. ```shell
  48. usage: FreeboxMoviePlanner.py [-h] [-d] [-l] [-e EXCLUDE] [-x EXCLUDE_DIRECTORY]
  49. Schedule movie recordings on your Freebox
  50. optional arguments:
  51. -h, --help show this help message and exit
  52. -d, --day Search movies for current day only instead of a full week
  53. -l, --log Display more log messages
  54. -e EXCLUDE, --exclude EXCLUDE
  55. Exclude the following Channel
  56. -x EXCLUDE_DIRECTORY, --exclude-directory EXCLUDE_DIRECTORY
  57. Do not display movies available in the following directory. This will prevent you from recording the same movie multiple times.
  58. ```