Skip to main content

A server which provides a WebSocket API for YouCube clients

Project description

YouCube Server

Python Version: 3.7+ Python Lint Workflow Status

preview

YouCube has a some public servers, which you can use if you don't want to host your own server.
The client has the public servers set by default, so you can just run the client, and you're good to go.
Moor Information about the servers can be seen on the doc.

Requirements

You can install the required packages with pip by running:

pip install -r src/requirements.txt

Starting the Server

python src/youcube.py

Environment variables

Environment variables you can use to configure the server:

Variable Default Description
HOST 127.0.0.1 The host where the web server runs on.
PORT 5000 The port where the web server should run on
FFMPEG_PATH ffmpeg Path to the FFmpeg executable
SANJUUNI_PATH sanjuuni Path to the Sanjuuni executable
NO_COLOR False Disable colored output
LOGLEVEL DEBUG Python Log level of the main logger
DISABLE_OPENCL False Disables sanjuuni GPU acceleration
NO_FAST False Disable Sanic worker processes maximization
SPOTIPY_CLIENT_ID The Client ID from your spotify application
SPOTIPY_CLIENT_SECRET The Client Secret from your spotify application
DATA_CACHE_CLEANUP_INTERVAL 300 Time interval (in seconds) for the data cache cleaner to wait before checking for outdated cache entries.
DATA_CACHE_CLEANUP_AFTER 3600 Time threshold (in seconds) for considering a cache entry outdated. Cache entries older than this will be removed.

And Sanic Builtin values.

Docker Compose

version: "2.0"
services:
  youcube:
    image: ghcr.io/cc-youcube/youcube:latest
    restart: always
    hostname: youcube
    ports:
      - 5000:5000

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

youcube-0.0.0.tar.gz (392.8 kB view hashes)

Uploaded Source

Built Distribution

youcube-0.0.0-py3-none-any.whl (29.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page