from emotionweb import Surprise
The Surprise class is the public entry
point used to create an EmotionWeb experience.
UNDER THE HOOD
From Python
to a website.
EmotionWeb takes a simple Python API call, prepares your personalized content, and uses its Django-powered web engine to generate the final web experience.
THE COMPLETE FLOW
What happens after generate()?
01
Your Python Code
You create the input
You import Surprise and provide
the occasion type, name, message, images and
captions.
02
Surprise(...)
EmotionWeb receives your data
The values supplied to the API become the content that will be used by the generated experience.
03
type
The occasion is selected
The selected type identifies the occasion experience that should be generated.
04
Content + Assets
Your content is prepared
Messages, names, captions and supplied images are prepared for use by the generated website.
05
Django
The web engine takes over
EmotionWeb uses Django as the web engine behind the generated experience and its templates.
06
Template
Dynamic content is rendered
Django templates can consume the supplied values and produce the corresponding web content.
07
HTML / CSS / JS
The experience is assembled
The generated website is composed from the template and its web assets.
08
Browser
You see the final experience
The generated web experience can then be opened and viewed in the browser.
STARTING POINT
It starts with a simple API.
example.py
from emotionweb import Surprise
s = Surprise(
type="birthday",
name="Aniket Vishwakarma",
message="chal aaja ghumne chalte h",
images=[
r"C:\path\to\img1.jpeg",
r"C:\path\to\img2.jpeg",
r"C:\path\to\img3.jpeg",
],
caption=[
"The solo travel that teaches me everything ❤️",
"This travel shows a different path ❤️",
"Very best view ❤️",
]
)
s.generate()
UNDERSTANDING THE COMPONENTS
What each part means.
Choose the occasion
The type value determines which
occasion/template experience is requested.
Personalize the experience
name and message provide
the main personalized text for the generated
experience.
Add your own images
Image paths can be supplied through the
images parameter for the generated
experience.
Describe the memories
The caption values provide text that
can accompany the supplied images.
s.generate()
Calling generate() starts the generation
process for the personalized web experience.
WEB ENGINE
Why Django is involved.
EmotionWeb is not only producing text or a static page. Its generated experience uses a Django-powered web engine to work with templates and dynamic content.
Templates
Django templates provide the structure
for dynamic content.
Dynamic Data
Values supplied through the API can be
used while rendering the experience.
Web Output
The result is a browser-viewable web
experience.