https://github.com/spragginsdesigns/spotlistmd

https://github.com/spragginsdesigns/spotlistmd

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/spragginsdesigns/spotlistmd
• Owner: spragginsdesigns
• Created: 2024-08-20T23:16:29.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-08-27T23:07:19.000Z (9 months ago)
• Last Synced: 2025-01-08T21:28:30.740Z (5 months ago)
• Language: Python
• Size: 2.93 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




SpotlistMD


SpotlistMD is a user-friendly desktop application that allows Spotify users to easily export their entire playlist library into a beautifully formatted Markdown file. With just a single click, you can create a comprehensive document containing detailed information about each of your Spotify playlists.


Features



    
✔ One-Click Export: Quickly fetch all your Spotify playlists and export them to a Markdown file.

    
✔ Detailed Playlist Information: Includes playlist names, descriptions, and track counts.

    
✔ Complete Track Listings: Each playlist export includes full track details (song title, artist, album).

    
✔ User-Friendly GUI: Clean and intuitive interface built with tkinter and ttkthemes.

    
✔ Progress Tracking: Real-time progress bar and status updates during the export process.

    
✔ Customizable Save Location: Choose where to save your exported Markdown file.

    
✔ Secure Configuration: Spotify API credentials are stored securely in a local configuration file.

    
✔ Dark Mode: Sleek dark-themed interface for comfortable use in low-light environments.



Installation



    
Clone this repository:

    


        
git clone https://github.com/spragginsdesigns/SpotlistMD.git

    

    
Navigate to the project directory:

    


        
cd SpotlistMD

    

    
Install the required dependencies:

    


        
pip install -r requirements.txt

    



Configuration

Before using SpotlistMD, you need to set up your Spotify API credentials:



    
Go to the Spotify Developer Dashboard and create a new application.

    
Copy your Client ID and Client Secret.

    
Set the Redirect URI in your Spotify app settings (e.g., http://localhost:8888/callback).

    
Create a config.json file in the project root with the following structure:





    

{

  "SPOTIPY_CLIENT_ID": "your_client_id_here",

  "SPOTIPY_CLIENT_SECRET": "your_client_secret_here",

  "SPOTIPY_REDIRECT_URI": "your_redirect_uri_here"

}

    



Usage



    
Run the application:

    


        
python main.py

    

    
Click the "Fetch Playlists" button to start the export process.

    
Choose a save location for your Markdown file when prompted.

    
Wait for the export to complete. You'll see a success message when it's done.



Contributing

Contributions to SpotlistMD are welcome! Please feel free to submit a Pull Request.


License

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


Acknowledgments

Special thanks to:



    
✔ Spotipy for the excellent Spotify API wrapper.

    
✔ ttkthemes for the beautiful GUI themes.



Author

Austin Spraggins

Website: SpragginsDesigns.xyz

GitHub: @spragginsdesigns


Support

If you encounter any problems or have any suggestions, please open an issue on GitHub.


SpotlistMD - Bringing your Spotify playlists to life in Markdown!