diff --git a/README.md b/README.md index b409de2..f2d994b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,95 @@ -# CertificateGenerator +

+ Certificate Generator +

+
+

+ +

+
+

A simple mass certificate generator script for the community ⚡

+ +

+
+ Source Code   ·   + Docs   ·   + Raw Script +
+

+
+ + +### Docs + +All you need + +- Certificate + - Design a [simple template](template.png) on [Canva](https://www.canva.com/) +- Font + - A .ttf (True-Type Font) file like [this](/font), can simply be downloaded from [here](https://www.google.com/search?q=download+.ttf+fonts). +- Names + - Finally, a list of names in a .txt format or a .csv format. + +
+ +### Pillow module + +Using the [pillow module](https://pypi.org/project/Pillow/) to make changes. +
+- Calculating and declaring default values. +```python +from PIL import Image, ImageFont, ImageDraw + +# Global Variables +FONT_FILE = ImageFont.truetype(r'font/GreatVibes-Regular.ttf', 180) +FONT_COLOR = "#FFFFFF" + +template = Image.open(r'template.png') +WIDTH, HEIGHT = template.size +``` +
+ +- Placing the name on the certificate and saving to a different directory. +```python +def make_certificates(name): + '''Function to save certificates as a .png file''' + + image_source = Image.open(r'template.png') + draw = ImageDraw.Draw(image_source) + + # Finding the width and height of the text. + name_width, name_height = draw.textsize(name, font=FONT_FILE) + + # Placing it in the center, then making some adjustments. + draw.text(((WIDTH - name_width) / 2, (HEIGHT - name_height) / 2 - 30), name, fill=FONT_COLOR, font=FONT_FILE) + + # Saving the certificates in a different directory. + image_source.save("./out/" + name +".png") + print('Saving Certificate of:', name) + +``` +
+ +### Names + +- Using `readlines()` method with a `.txt` format. + +```python +names = [] + +with open('names.txt') as f: + content = f.readlines() + for item in content: + names.append(item[:-1].title()) +``` +
+- Using [pandas to read a `.csv` file](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.read_csv.html). + +```python +import pandas +names = pandas.read_csv('names.csv', sep='#') +``` + +## Author + +- [Tushar Nankani](https://www.linkedin.com/in/tusharnankani/) -A simple mass certificate generator script for the community ⚡