mirror of
https://github.com/shadoll/playing_now_2_mm.git
synced 2025-12-20 06:29:52 +00:00
Update readme.md
This commit is contained in:
23
readme.md
23
readme.md
@@ -1,6 +1,6 @@
|
||||
# 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 or GitLab.
|
||||
|
||||
## Features
|
||||
- Fetches current playing track from `Apple Music` or `Spotify`
|
||||
@@ -10,22 +10,35 @@ This is a Python application that fetches the currently playing track from eithe
|
||||
## Dependencies
|
||||
- MacOS
|
||||
- Python 3
|
||||
- Apple Music or Spotify
|
||||
|
||||
## Sources
|
||||
- Apple Music
|
||||
- Spotify
|
||||
- Random - generate random status with emoji icon
|
||||
|
||||
## Destionations
|
||||
- Mattermost
|
||||
- GitLab
|
||||
|
||||
## Environment Variables
|
||||
`SOURCE` - This variable determines which music service the application will fetch the currently playing track from. It can be set to `autodetect` to automatically detect the running music application.
|
||||
`DESTINATION` - This variable determines the destination of the status update.
|
||||
|
||||
`MATTERMOST_SERVER_URL` variable represents the URL of the Mattermost server.
|
||||
`MATTERMOST_SERVER_URL` - variable represents the URL of the Mattermost server.
|
||||
|
||||
`MATTERMOST_ACCESS_TOKEN` - the access token for the Mattermost API, which is obtained by generating a personal access token from the Mattermost user settings and is used to authenticate and authorize API requests to the Mattermost server.
|
||||
|
||||
`GITLAB_SERVER_URL` - the URL of the Mattermost server.
|
||||
`GITLAB_ACCESS_TOKEN` - the access token for the GitLab API
|
||||
|
||||
`MATTERMOST_ACCESS_TOKEN` the access token for the Mattermost API, which is obtained by generating a personal access token from the Mattermost user settings and is used to authenticate and authorize API requests to the Mattermost server.
|
||||
|
||||
## How to Run
|
||||
1. Clone the repository
|
||||
2. Install the dependencies with `pip install -r requirements.txt`
|
||||
3. Set Mattermost token and host in `.env`
|
||||
4. Set the `SOURCE` environment variable to your preferred music service
|
||||
5. Run the application with `python main.py`
|
||||
5. Set the `DESTINATION` environment variable
|
||||
6. Run the application with `python main.py`
|
||||
|
||||
## Note
|
||||
The application runs in an infinite loop, constantly checking for changes in the currently playing track and updating your Mattermost status accordingly.
|
||||
|
||||
Reference in New Issue
Block a user