sha/playing_now_2_mm
1
0
Fork 0
mirror of https://github.com/shadoll/playing_now_2_mm.git synced 2025-12-20 06:29:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update readme.md with improved formatting and instructions

Browse Source
This commit is contained in:
sHa
2024-04-05 14:54:56 +03:00
parent 30f50c3548
commit 90bd6c66ab
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
readme.txt → readme.md
View File

@@ -1,27 +1,27 @@
#Music Status Updater # Music Status Updater
This is a Python application that fetches the currently playing track from either Apple Music or Spotify and sets it as your status on Mattermost. This is a Python application that fetches the currently playing track from either Apple Music or Spotify and sets it as your status on Mattermost.
##Features ## Features
- Fetches current playing track from `Apple Music` or `Spotify` - Fetches current playing track from `Apple Music` or `Spotify`
- Sets the track as your status on Mattermost - Sets the track as your status on Mattermost
- Using Appscript and Osascript for Music Track Information on MacOS - Using Appscript and Osascript for Music Track Information on MacOS
##Dependencies ## Dependencies
- MacOS - MacOS
- Python 3 - Python 3
- Apple Music or Spotify - Apple Music or Spotify
- Mattermost - Mattermost
##Environment Variables ## Environment Variables
`MUSIC_APP`: This variable determines which music service the application will fetch the currently playing track from. It can be either `apple_music` or `spotify`. `MUSIC_APP`: This variable determines which music service the application will fetch the currently playing track from. It can be either `apple_music` or `spotify`.
##How to Run ## How to Run
1. Clone the repository 1. Clone the repository
2. Install the dependencies with `pip install -r requirements.txt` 2. Install the dependencies with `pip install -r requirements.txt`
3. Set Mattermost token and host in `.env` 3. Set Mattermost token and host in `.env`
4. Set the `MUSIC_APP` environment variable to your preferred music service 4. Set the `MUSIC_APP` environment variable to your preferred music service
5. Run the application with `python music_app.py` 5. Run the application with `python music_app.py`
##Note ## Note
The application runs in an infinite loop, constantly checking for changes in the currently playing track and updating your Mattermost status accordingly. The application runs in an infinite loop, constantly checking for changes in the currently playing track and updating your Mattermost status accordingly.