spotify_volume_control.py

import os
from time import sleep
import argparse
import logging
import traceback
import requests.exceptions

from spotipy_lib.spotipy import Spotipy
from spotipy_lib.spotipy import SpotifyException
from configuration.configuration import Configuration

logger = logging.getLogger('Spotify Connect')


def _setup_log(log_path: str = 'logs/output.log', debug: bool = False) -> None:
    """ Sets up logger. """

    log_path = log_path.split(os.sep)
    if len(log_path) > 1:
        try:
            os.makedirs((os.sep.join(log_path[:-1])))
        except FileExistsError:
            pass
    log_filename = os.sep.join(log_path)
    # noinspection PyArgumentList
    logging.basicConfig(level=logging.INFO if debug is not True else logging.DEBUG,
                        format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
                        datefmt='%Y-%m-%d %H:%M:%S',
                        handlers=[
                            logging.FileHandler(log_filename),
                            # logging.handlers.TimedRotatingFileHandler(log_filename, when='midnight', interval=1),
                            logging.StreamHandler()
                        ]
                        )


def _argparser() -> argparse.Namespace:
    """ Parses and returns the command line arguments. """

    parser = argparse.ArgumentParser(
        description='Script to trigger Spotify Connect to play on specific device.',
        add_help=False)
    # Required Args
    required_arguments = parser.add_argument_group('Required Arguments')
    config_file_params = {
        'type': argparse.FileType('r'),
        'required': True,
        'help': "The configuration yml file"
    }
    required_arguments.add_argument('-v', '--volume-direction', choices=['increase', 'decrease'],
                                    required=True,
                                    default='increase',
                                    help='Whether to increase or decrease volume')
    required_arguments.add_argument('-c', '--config-file', **config_file_params)
    required_arguments.add_argument('-l', '--log', help="Name of the output log file")
    # Optional args
    optional = parser.add_argument_group('Optional Arguments')
    optional.add_argument('-d', '--debug', action='store_true', help='Enables the debug log messages')
    optional.add_argument("-h", "--help", action="help", help="Show this help message and exit")

    return parser.parse_args()


def main():
    """
    Handles the core flow of SpotiClick.

    :Example:
    python main.py -c confs/raspotify_conf.yml
                   -l logs/spoticlick.log
    """

    # Initializing
    args = _argparser()
    _setup_log(args.log, args.debug)
    # Load the configuration
    configuration = Configuration(config_src=args.config_file)
    # Init Spotipy
    spoti_read_config = configuration.get_spotifies()[0]
    spoti_modify_config = configuration.get_spotifies()[1]
    spot_read = Spotipy(config=spoti_read_config, token_id='read')
    spot_modify = Spotipy(config=spoti_modify_config, token_id='modify')
    logger.debug("%s volume by 5%%.." % ("Increasing" if args.volume_direction == 'increase' else "Decreasing"))
    spot_modify.volume_update(direction=args.volume_direction, current_volume=spot_read.get_current_volume())
    logger.debug("Volume changed!")


if __name__ == '__main__':
    try:
        main()
    except Exception as e:
        logging.error(str(e) + '\n' + str(traceback.format_exc()))
        raise e