BeatPrints 1.0.2

Create eye-catching, pinterest-style music posters effortlessly.

BeatPrints: Quick, stylish posters for your favorite tracks! 🎷☕️

Create eye-catching, Pinterest-style music posters effortlessly. BeatPrints integrates with Spotify and LRClib API to help you design custom posters for your favorite tracks or albums. 🍀

📔 Check out the new documentation here!

📦 Installation

You can install BeatPrints via pip:

pip install BeatPrints

Or, if you use Poetry:

poetry add BeatPrints

🌱 Environment Variables

To get started with BeatPrints, you’ll need a .env file with these keys:

SPOTIFY_CLIENT_ID = "<your-client-id>"
SPOTIFY_CLIENT_SECRET = "<your-client-secret>"

You can get these from the Spotify Developer Dashboard by creating a new app with Web API as the scope.

🚀 Quick Start

Here’s how you can create your first poster:

import os, dotenv
from BeatPrints import lyrics, poster, spotify

dotenv.load_dotenv()

# Spotify credentials
CLIENT_ID = os.getenv("SPOTIFY_CLIENT_ID")
CLIENT_SECRET = os.getenv("SPOTIFY_CLIENT_SECRET")

# Initialize components
ly = lyrics.Lyrics()
ps = poster.Poster("./")
sp = spotify.Spotify(CLIENT_ID, CLIENT_SECRET)

# Search for a track
search = sp.get_track("Saturn by SZA", limit=1)

# Get the track's metadata and lyrics
metadata = search[0]
lyrics = ly.get_lyrics(metadata)
highlighted_lyrics = ly.select_lines(lyrics, "5-9")

# Generate the track poster
ps.track(metadata, highlighted_lyrics)

🥞 CLI Setup

To get started with the BeatPrints CLI, you'll need to set up a configuration file.

Windows

1. Create a folder named BeatPrints in the following directory:

C:\Users\<YourUsername>\AppData\Roaming\BeatPrints\

2. Inside this folder, create a file called config.toml with the following contents:

[general]
search_limit = 7
output_directory = "<path-to-save-your-posters>" 

[credentials]
client_id = "your-client-id"
client_secret = "your-client-secret"

Replace <path-to-save-your-posters> with the path where you'd like to save the generated posters, and fill in the client_id and client_secret with your Spotify credentials.

Linux or macOS

1. Create a folder named BeatPrints in your ~/.config/ directory:

~/.config/BeatPrints/

3. Inside this folder, create a file called config.toml with the same contents as mentioned above.

Running the CLI

Once the config file is set up, you can run the BeatPrints CLI:

1. Open your terminal.
2. Type beatprints and press Enter.

Your poster will be saved in the output directory you specified in the config.toml file.

🖼️ Examples

Here are a few posters created with BeatPrints:

Track: Saturn by SZA	Album: Charm by Clairo

For more examples, check out the examples directory.

✨ Features

• Polaroid Filter for Covers: Give your track or album covers a vintage Polaroid look.
• Multi-language Support: Supports English, Hindi, Russian, Japanese, Chinese, and Korean.
• Custom Cover Images: Personalize posters with your own images.
• Theme Customization: Switch between Dark and Light themes.
• Track & Album Selection: Highlight your favorite track or entire album.
• Lyrics Highlighting: Feature impactful lyrics directly on your poster.

🤝 Contributors

Thank you to all contributors for making BeatPrints better!

💡 Why BeatPrints?

I created this project after finding out that people sell these posters on Etsy at high prices, offering only digital downloads instead of shipping actual posters.

I wanted to make it free for everyone to print themselves, as I believe my posters are simpler, cleaner, and prettier.

❤️ Special Thanks

• A big thanks to Spotify Poster Generator by @AnveshakR for inspiring BeatPrints with amazing ideas!
• Shoutout to @Magniquick, @Krishna-Gunjan, and @itsnotrin for their awesome contributions!
• Thanks to @T-Dynamos and @cherriae for their great improvements and tweaks.
• A special nod to @itsnotrin for helping make album poster generation possible!

📜 License

BeatPrints is distributed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License:

• Use: Free to share and adapt.
• Attribution: Provide credit and a link to the license.
• NonCommercial: Not for commercial use.
• ShareAlike: Adaptations must follow the same license.

Read the full license here.

Made with 💜
elysianmyst, 2024