Create eye-catching, pinterest-style music posters effortlessly.
Project description
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:
# For pip users
pip install BeatPrints
# For poetry users
poetry add BeatPrints
Or if you prefer using just the CLI:
pipx install BeatPrints
This will install the CLI, making it ready for you to use. For more more infomation, check out pipx
🌱 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 - 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
Here’s a short video showing how to generate posters using the CLI. For more information refer to the documentation here
https://github.com/user-attachments/assets/3efb7028-c533-4bf4-880b-da3a71f8a3db
🖼️ 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file beatprints-1.1.0.tar.gz.
File metadata
- Download URL: beatprints-1.1.0.tar.gz
- Upload date:
- Size: 51.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bcaacec6bb8f7bfe56189f424bc78145ea840b68d17d31f5f6cabb1d7768a801
|
|
| MD5 |
e8ffcfd5f8ff7969246ab09093ac8999
|
|
| BLAKE2b-256 |
acc0cc3cd50a3edc5294f7fe69be5b1fb236adf83f3088e0fbe8fb796117d9c9
|
Provenance
The following attestation bundles were made for beatprints-1.1.0.tar.gz:
Publisher:
publish-to-pypi.yml on TrueMyst/BeatPrints
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
beatprints-1.1.0.tar.gz -
Subject digest:
bcaacec6bb8f7bfe56189f424bc78145ea840b68d17d31f5f6cabb1d7768a801 - Sigstore transparency entry: 158524784
- Sigstore integration time:
-
Permalink:
TrueMyst/BeatPrints@5644f1a0b24d89e3d39444ad9ac76db01a6e2b5d -
Branch / Tag:
refs/tags/v1.1.0 - Owner: https://github.com/TrueMyst
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@5644f1a0b24d89e3d39444ad9ac76db01a6e2b5d -
Trigger Event:
push
-
Statement type:
File details
Details for the file beatprints-1.1.0-py3-none-any.whl.
File metadata
- Download URL: beatprints-1.1.0-py3-none-any.whl
- Upload date:
- Size: 51.7 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bf5b4da277a07842f03d1cc22a5360b83cd1aa131dc6cc85801be97abe8e405d
|
|
| MD5 |
83f9525804f5ca3ef776bff8005f31e4
|
|
| BLAKE2b-256 |
cf45fe4c236438ba0c5148f566633c992f632e75d833d8425584fb0f5fdaaa92
|
Provenance
The following attestation bundles were made for beatprints-1.1.0-py3-none-any.whl:
Publisher:
publish-to-pypi.yml on TrueMyst/BeatPrints
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
beatprints-1.1.0-py3-none-any.whl -
Subject digest:
bf5b4da277a07842f03d1cc22a5360b83cd1aa131dc6cc85801be97abe8e405d - Sigstore transparency entry: 158524785
- Sigstore integration time:
-
Permalink:
TrueMyst/BeatPrints@5644f1a0b24d89e3d39444ad9ac76db01a6e2b5d -
Branch / Tag:
refs/tags/v1.1.0 - Owner: https://github.com/TrueMyst
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-to-pypi.yml@5644f1a0b24d89e3d39444ad9ac76db01a6e2b5d -
Trigger Event:
push
-
Statement type: