Skip to main content

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. 🍀

Maintenance GitHub Repo stars Code Formatter Static Badge

examples

📔 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 - 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
Track Example Album Example

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

📜 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beatprints-1.0.5.tar.gz (51.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

beatprints-1.0.5-py3-none-any.whl (51.6 MB view details)

Uploaded Python 3

File details

Details for the file beatprints-1.0.5.tar.gz.

File metadata

  • Download URL: beatprints-1.0.5.tar.gz
  • Upload date:
  • Size: 51.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for beatprints-1.0.5.tar.gz
Algorithm Hash digest
SHA256 3eba7c43646f366220394ad4b70bf1072cc48210fb5178b54b348eeaab1176c8
MD5 9cfafbf0fcacb3ef3d20f53a8183170c
BLAKE2b-256 79241a48edbdc51cca6bab0e12ec397cc5155a809b455ff3ec0033f205149548

See more details on using hashes here.

Provenance

The following attestation bundles were made for beatprints-1.0.5.tar.gz:

Publisher: publish-to-pypi.yml on TrueMyst/BeatPrints

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file beatprints-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: beatprints-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 51.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for beatprints-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ebeb592a85dc0b773ada58dbea576192c526a35b4b957fa923ab907c039f583f
MD5 ccae269feb206d8816cf5d710f1871ff
BLAKE2b-256 88fdc1e99e7acbe5d71423805a6caa2244d92ad537bb6b345217998754247358

See more details on using hashes here.

Provenance

The following attestation bundles were made for beatprints-1.0.5-py3-none-any.whl:

Publisher: publish-to-pypi.yml on TrueMyst/BeatPrints

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page