/UF_DEV_LOGICIEL

Primary LanguagePythonMIT LicenseMIT

SPOTIFIX

  1. Mon projet
    1. Description
    2. Raison du developpement
  2. Fonctionalité et Téchnologies Utilisées
    1. Téchnologies Utilisées
    2. Fonctionalités
  3. Guide d'installation
    1. Elements requis
    2. Installation des packages necessaire
    3. Installation de Spotifix
  4. Fonctionnement et utilisation
    1. Menu
    2. Search for an artist
    3. Search for a playlist
    4. Play one of my playlist
    5. Setting playlist
  5. Bug à corriger
  6. Annexes

1 Mon Projet

1 Description

Spotifix est un logiciel permetant d'utiliser Spotify en CLI. À la différence de spotify-cli l'interface cli est bien plus petite avec seulement les informations nécessaires à l'instant T. Et contrairement à tizonia il embarque plus de fonctionalités et est plus léger.

Spotifix utilise l'api de spotify, ce qui permet d'avoir les mêmes fonctionalités que le client lourd (enfin pas pour le moment mais c'est le but). Il est bien plus léger que le client lourd et n'a pas besoin d'interface graphique.

2 Raison du développement

Spotifix à été developpé lors d'un projet d'étude. Le but premier était de développer un mixte de tizonia et de spotify-cli en prenant exemple de l'interface CLI épurée de tizonia couplée aux fonctionalités de spotify-cli.

Developpé en python il permet de s'intaller facilement sur n'importe quelle architecture RISC.

2 Fonctionalités et Technologies Utilisées

Ma documentation technique en PDF : Documentation technique

I Téchnologies Utilisées

Langage:

  • Python3

SDK:

  • spotipy

Lib:

  • datetime
  • time
  • threading
  • sys
  • os
  • json

II fonctionalités

  • Rechercher un artist et jouer un de ses sons.
  • Rechercher une playlist et la jouer
  • Voir mes playlist et les jouer.
  • Lecteur avec une barre de progression en temps réel
  • Modifier mes playlists

Fonctionalités du lecteur:

  • Lecture / Pause
  • Volume + / -
  • Suivre la playlist
  • Ajouter un son à une playlist
  • Lecture aléatoire
  • Chanson suivante
  • Chanson précédente

Fonctionalités de modification de playlist:

  • Changer le nom
  • Changer la description
  • Changer l'état de la playlist (Public/Privé)
  • Surprimmer un son de la playlist
  • Ajouter un son d'une playlist à une autre
  • Créer une playlist
  • Se désabonner d'une playlist

3 Guide d'installation

Instalation faite sous Arch-Linux

I Eléments requis

Pour installer et utiliser Spotifix vous devez avoir:

  1. Un compte Spotify premium
  2. Le client Lourd de spotify ou un moteur de recherche avec spotify de lancé dessus (en étant connecté).
  3. Python3
  4. Git

II Installation des packages necessaire

  1. Installation de python3
sudo pacman -Syyuu
sudo pacman -S python3
  1. Installation des différents packages nécessaires:
sudo pip3 install threaded spotipy jsondiff jsonschema datetime spotify

III Installation de Spotifix

  1. Installtion de git
sudo pacman -S git
  1. git clone sur mon projet
git clone https://github.com/FlorianLeveil/UF_DEV_LOGICIEL
  1. Recolter sa clé privé et public spotify.

    1. Aller sur ce lien: https://developer.spotify.com/dashboard/ GitHub Logo
    2. Se connecter
    3. Créer un nouveau projet GitHub Logo
    4. Cliquer sur votre nouveau projet
    5. Copier coller votre client-id dans le main.py à la ligne 17 GitHub Logo
    6. Appuyer sur Show client secret et copier coller votre client secret dans le main.py à la ligne 16.
  2. Spotifix est installé. Pour l'éxcuter faire comme ceci:

python3 ./main.py <user_name>

4 Fonctionnement et utilisation

I Menu

Menu


II Search for an artist

Mettre le nom de l'ariste que vous voulez

GitHub Logo

Entrer le numero du son que vous voulez jouer

GitHub Logo

Lecteur:

GitHub Logo

Les commandes:

  • p : Met votre son en pause
  • l : Met votre son en lecture
  • / - / + : Monter et descendre le volume de spotify
  • x : quitter et revenir au menu précedent
  • r : Ajoute le son a la playlist de votre choix

Pour ajouter le son a une de vos playlist entrer r puis entrer le numero de votre playlist

GitHub Logo


III Search for a playlist

Taper le nom de la playlist ou le genre que vous voulez et entrer le numéro de la playlist

GitHub Logo

Lecteur:

GitHub Logo

Les commandes:

  • p : Met votre son en pause
  • l : Met votre son en lecture
  • s : Lit vos sons de façon aléatoire
  • n : Son suivant
  • b : Son précedent
  • / - / + : Monter et descendre le volume de spotify
  • x : quitter et revenir au menu précedent
  • a : Suivre la playlist

IV Play one of my playlist

Taper le numéro de la playlist que vous voulez jouer

GitHub Logo

Lecteur:

GitHub Logo

Les commandes:

  • p : Met votre son en pause
  • l : Met votre son en lecture
  • s : Lit vos sons de façon aléatoire
  • n : Son suivant
  • b : Son précedent
  • / - / + : Monter et descendre le volume de spotify
  • x : quitter et revenir au menu précedent

V Setting playlist

Choisir entre modifier une playlist ou en créer une

GitHub Logo

Choix 1: Modifier une playlist

entrer le numéro de votre playlist

GitHub Logo

Si vous êtes le proprietaire de la playlist vous tomberez sur ce menu

GitHub Logo

Les commandes:

  • 1 : Supprimer un son de votre playlist
  • 2 : Changer le nom de votre playlist
  • 3 : Mettre votre playlist en public ou privé
  • 4 : Changer la description de votre playlist
  • 5 : Quitter

Supprimer le son de votre playlist

Entrer le numéro du son que vous voulez supprimer

GitHub Logo

Changer le nom de votre playlist

entrer votre nouveau nom

GitHub Logo

Mettre votre playlist en public ou privé

entrer public ou private

GitHub Logo

Changer la description de votre playlist

Entrer la nouvelle descritpion de votre playlist

GitHub Logo

Si vous n'êtes pas le proprietaire de la playlist vous tomberez sur ce menu

GitHub Logo

Les commandes:

  • 1 : Se désabonner de la playlist
  • 2 : Ajouter un des sons de cette playlist à une autre

Ajouter un des sons de cette playlist à une autre

entrer le numéro du son concerné

GitHub Logo

Entrer le numéro de la playlist concernée

GitHub Logo

Choix 2: Créer une playlist

entrer le nom de votre playlist

GitHub Logo

entrer la description de votre playlist

GitHub Logo

Choisir entre public ou privé!

GitHub Logo

Confirmer la création de votre playlist

GitHub Logo


5 Bug à corriger

  1. Vous ne pouvez pas quitter le lecteur si le son ou la playlist est en pause
  2. Vous ne pouvez pas activer la fonction shuffle sur une playlist puis revenir sur la recherche d'artist pour lire un son
  3. La fonction resume ne marche plus des lors que vous rentrez dans le menu de modification de playlist
  4. Gérer la casse sur les fonctions suivante:
    • Resume
    • Chercher un artiste
    • Chercher une playlist
    • Jouer une de mes playlist

6 Annexes