Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 1.86 KB

README.md

File metadata and controls

68 lines (45 loc) · 1.86 KB
Raw

🎵 Music Slack Status 🎵

Welcome to music-slack-status! This groovy project syncs your current Spotify jam with your Slack status, so your colleagues always know what tunes you're vibing to. 🎧

🚀 Getting Started

Prerequisites

Make sure you have the following installed:

  • Python 3.11+
  • Poetry for dependency management

Installation

  1. Clone the repo:

    git clone https://github.com/yourusername/music-slack-status.git
cd music-slack-status

  2. Install dependencies:

    poetry install

  3. Set up your environment variables:

    Copy the .env.example to .env and fill in your credentials:

    cp .env.example .env

    Edit the .env file with your favorite editor and add your Slack and Spotify credentials:

    SLACK_USER_TOKEN=xoxp-your-slack-token
SLACK_USER_ID=your-slack-user-id
SPOTIPY_CLIENT_ID=your-spotify-client-id
SPOTIPY_CLIENT_SECRET=your-spotify-client-secret
SPOTIPY_REDIRECT_URI=https://localhost:8888/callback

Running the Project

  1. Fire up the script:

    poetry run python main.py

    Or, if you prefer to specify the Slack user ID directly:

    poetry run python main.py your-slack-user-id

  2. Authenticate with Spotify

  3. Watch the magic happen!!

🌟 Contributing

Feel free to fork this project and submit pull requests. Let's make this project even more awesome together! 🤘

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.