Social Preview Autogenerator

An autogenerator for your repo social preview

📕 Installation

🕷️ Create an environment

Whatever you prefer (e.g. conda or venv)

mkdir myproject
$ cd myproject
$ python3 -m venv venv

🕷️ Activate the venv folder

Windows:

venv\Scripts\activate

Mac / Linux (Create a venv, activate it and install requirements.txt):

. python3 -m venv venv
. venv/bin/activate

🕷️ Install Dependencies

Install Dependencies only for Mac/Linux:

. pip install -r requirements.txt

⚙️ Customize the preview

Inside assets folder you have,

#	Image	Size (width x height)
Background		1280 x 640 px
Face		300 x 300 px
Signature		250 x 65 px
Contributors Icon		40 x 40 px
Forks Icon		40 x 40 px
Issues Icon		40 x 40 px
Stars Icon		40 x 40 px
Github Icon		100 x 100 px

You can change the images according to your usage. Remember to KEEP THE SAME SIZE as of the image you are replacing.

👨‍💻 Usage

Find the link of your repo. Paste it inside url variable inside scrape.py file.

url = "https://github.com/Abhijith14/GitSocialPreview"

Run

python main.py

This will start creating the preview.
You can find your results inside output folder as : gitusername/reponame.png
Eg : Abhijith14/GitSocialPreview.png

🛠️ Built With

• Python 3.7 - Creating Project

❤️ Authors

• Abhijith Udayakumar - Design & Development - Abhijith14

🚨 Forking this repo (please read!)

yes, with attribution.

I value keeping my work open source, but as you all know, plagiarism is bad. It's always disheartening whenever I find that someone has copied my work without giving me credit. I spent a non-trivial amount of effort building and designing this project, and I am proud of it! All I ask of you all is to not claim this effort as your own.

TL;DR

Yes, you can fork this repo. Please give me proper credit by linking back to Abhijith14/GitSocialPreview. Thanks!