Skip to main content

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 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\
  1. 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/
  1. 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
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

Metadata

Release files for BeatPrints 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for BeatPrints 1.0.2
File Size Uploaded Provenance Actions
beatprints-1.0.2.tar.gz 51.5 MB With provenance Details for beatprints-1.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for BeatPrints 1.0.2
File Interpreter ABI Platform Actions
beatprints-1.0.2-py3-none-any.whl Python 3 none any Details for beatprints-1.0.2-py3-none-any.whl

Total release size: 103.2 MB

Release files / beatprints-1.0.2.tar.gz

Download URL beatprints-1.0.2.tar.gz
Size 51.5 MB
Tags Source
SHA-256 checksum
How to use checksums
6f58aae9296bed773cbeb3826e0f8762f9906e2b0be1eea3fdee6cf08bad507d
BLAKE2b-256 checksum
How to use checksums
2eddbc25e2d093334bf9bf3c9f4f1889c4f25e56314fcacf50d2f7f7c2ad0aa2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 15, 2024.

Transparency log

Release files / beatprints-1.0.2-py3-none-any.whl

Download URL beatprints-1.0.2-py3-none-any.whl
Size 51.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
b394d872ae611ec4d4143cd16806f756a50438dc7803495fed509a1aaddfaee7
BLAKE2b-256 checksum
How to use checksums
f56999611d77a2fb0a8c276f3f98cf5b12daccecea8e9864cc39e3770660d651
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.0.1 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 15, 2024.

Transparency log

Security for BeatPrints 1.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for beatprints-1.0.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Dec 15, 2024.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page