Skip to content

TrueMyst/BeatPrints

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation



BeatPrints, a tool that generates eye-catching pinterest-style music posters ☕

Maintenance GitHub Repo stars Code Formatter Static Badge

examples

BeatPrints is a tool designed to create eye-catching music posters that stand out. It provides a straightforward way to generate custom posters using Spotify and MusixMatch API. 🍀

📜 Getting Started

1.1 Installation

Clone this repository into your preferred directory using Git:

git clone --depth 1 https://github.com/TrueMyst/BeatPrints.git
cd BeatPrints

1.2 Dependencies

Install the necessary dependencies using pip:

$ pip install -r requirements.txt

This ensures all required packages are installed to run the project smoothly.

1.3 Environment Variables

To run this project, set up the required environment variables in the .env file by creating it in the ./src directory. These variables include:

1.4 Generating Posters

Navigate to the ./src directory and execute the following command:

$ python3 main.py

For now BeatPrints offers these such features:

  • Custom Image: Add a personalized touch by adding your own image as the cover
  • Song Selection: Highlight your favorite track from your favorite artist
  • Lyrics Selection: Feature lyrics that resonate with you

More features are yet to come :)

1.5 We got more samples!

If you're looking for more samples, no worries—we've got you covered. Head to the examples directory to find additional posters available for viewing.

🤝 Contributing

Contributions to BeatPrints are welcome. Feel free to submit your suggestions via pull requests. Your contributions are invaluable in enhancing this tool for everyone.

💡 Inspiration & Gratitude

I stumbled upon incredible music posters on Pinterest and was amazed by their uniqueness. Not finding a platform to create similarly diverse and appealing designs, I set out to develop a program that simplifies the process with just a few clicks and inputs. Surprisingly, the result exceeded my expectations, resulting in BeatPrints!

📋 About License

BeatPrints is released under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License, which grants the following permissions:

  • Use: Copy, share, and adapt the material.
  • Attribution: Provide appropriate credit to the owner and a link to the license.
  • NonCommercial: Don't use it for commercial purposes.
  • ShareAlike: Share adaptations under the same license.
  • No Additional Restrictions: Don't impose extra legal or technological limitations.

For more detailed information, please check out the LICENSE


Made with 💜
elysianmyst, 2024

Releases

No releases published

Packages

No packages published

Languages