pycooltext-api 0.1.3

A Python wrapper for the CoolText.com image generation API

pycooltext-api

A Python wrapper for the CoolText.com image generation API. Build typed payloads, post to CoolText's /PostChange endpoint, and get back a rendered image URL — all in a few lines of code.

Installation

pip install pycooltext-api

Quick Start

from cooltext import CoolText, PostChangeConfigOptions

config = PostChangeConfigOptions(LogoID="732440996", Text="Hello World")
result = CoolText(config).create()

print(result)           # prints the image URL
result.download()       # saves the image locally

Browse Available Logos

Visit https://thehritu.github.io/CoolText/ to browse all available logo styles and their IDs.

Configuration

PostChangeConfigOptions accepts these fields:

Field	Type	Default	Description
LogoID	str	required	ID of the CoolText logo style
Text	str	"Cool Text"	Text to render
FontSize	str	"70"	Font size
FileFormat	str	"PNG"	Output format
BackgroundColor_color	str	"FFFFFF"	Background colour (hex)
Color1_color	str	None	Primary text colour
Color2_color	str	None	Secondary colour
Boolean1–Boolean3	str	None	Logo-specific toggles
Integer1–Integer14_color	str	None	Logo-specific numeric options

Get default configuration values for a logo:

Returns a dictionary of all default values for the given logo id

from cooltext import CoolText, PostChangeConfigOptions

config = PostChangeConfigOptions(LogoID="2975689126")
defaults = CoolText(config).get_defaults()
print(defaults)

CoolTextResult

CoolText.create() returns a CoolTextResult object:

result = CoolText(config).create()

str(result)                               # the image URL as a string
bool(result)                              # False if the request failed
result.download()                         # save to current directory
result.download("out.png")                # save to a specific path
result.download("out.png", stream=False)  # disable streaming

Finding a Logo ID

Go to https://thehritu.github.io/CoolText/ — every logo is listed with its ID and default configuration values.

Search for logos by keyword:

Search for logos on cooltext.com by keyword:

from cooltext import CoolTextSearch
results = CoolTextSearch().search("gold") # list of CoolTextSearchResult
for result in results:
    print(result.title, " - ", result.link)
    print(result.to_dict())  # get title and link as a dictionary

CoolTextSearchResult

CoolTextSearch.search() returns a list of CoolTextSearchResult objects.

CoolTextSearchResult has these attributes:

• title: The logo's title (e.g. "Gold Text")
• link: The URL to the logo's page on CoolText.com

CoolTextSearchResult has these methods:

• to_dict(): Returns a dictionary with the title and link

from cooltext.modules import CoolTextSearchResult

result = CoolTextSearchResult("Gold Text", "https://cooltext.com/Logo-ID/1234567890")
print(result.title)  # "Gold Text"
print(result.link)   # "https://cooltext.com/Logo-ID/1234567890"
print(result.to_dict())  # {"title": "Gold Text", "link": "https://cooltext.com/Logo-ID/1234567890"}

Links

• GitHub: https://github.com/TheHritu/CoolText
• Logo ID List: https://thehritu.github.io/CoolText/
• PyPI: https://pypi.org/project/pycooltext-api/

License

MIT © TheHritu