Build personal websites with Python.

Welcome to EmotionWeb.

EmotionWeb brings together software development and personalized digital experiences.

Instead of manually rebuilding a similar website every time you want to create a personalized experience, you can provide the required information to EmotionWeb and generate a website from a reusable template.

This documentation explains the package from installation and first use to the public API, template system and internal generation flow.

What is EmotionWeb?

EmotionWeb is an open-source Python library designed to automate the generation of personalized event and surprise websites.

The developer supplies information such as a recipient name, message, occasion type, images and captions. EmotionWeb processes that data through its website-generation system and applies the selected template.

Why does it exist?

Personalized websites often contain the same basic development work repeatedly:

• HTML structure
• CSS styling
• JavaScript behaviour
• image and static-resource handling
• personalized content placement

EmotionWeb attempts to make this repetitive process reusable through templates and programmatic generation.

What EmotionWeb provides.

Installation.

EmotionWeb is distributed as a Python package. Install it using pip.

pip install emotionweb

Verify the installation

After installation, Python can import the package and expose the Surprise class.

from emotionweb import Surprise

Your first EmotionWeb website.

The basic workflow is simple: import Surprise, provide the required information, then call generate().

from emotionweb import Surprise

s = Surprise(
    type="birthday",
    name="Aniket Vishwakarma",
    message="chal aaja ghumne chalte h",
    images=[
        r"C:\Users\DELL\Desktop\EmotionWeb\webengine\static\uploads\img7.jpeg",
        r"C:\Users\DELL\Desktop\EmotionWeb\webengine\static\uploads\img8.jpeg",
        r"C:\Users\DELL\Desktop\EmotionWeb\webengine\static\uploads\img6.jpeg",
        r"C:\Users\DELL\Desktop\EmotionWeb\webengine\static\u uploads\img5.jpeg",
    ],
    caption=[
        "The solo travel that teaches me everything ❤️",
        "This travel shows a different path of Bihar ❤️",
        "And this one is closest to heart because its my Varanasi yaar ❤️",
        "Very best view ❤️",
    ]
)

s.generate()

What happened here?

1. Python imports Surprise from EmotionWeb.
2. A Surprise object is created with the personalized data.
3. The selected type determines the occasion/template path used by the package.
4. Images and captions are supplied as collections.
5. generate() starts the website generation process.

Surprise API.

The primary public interface is the Surprise class.

type

The type value selects the occasion/template used for generation.

type="birthday"

name

The name parameter contains the recipient or primary personalized name.

name="Aniket Vishwakarma"

message

The message contains the personalized text that is passed to the selected template.

images

Images are provided as a Python list containing file paths.

caption

Captions are also supplied as a list. The selected template can use these values while rendering the generated website.

Supported occasions.

EmotionWeb is built around reusable occasion templates. The currently documented occasion types are:

Images & captions.

EmotionWeb accepts image paths through the images parameter.

images=[
    r"C:\path\to\photo1.jpeg",
    r"C:\path\to\photo2.jpeg",
    r"C:\path\to\photo3.jpeg",
]

Captions

Captions are provided through the caption list.

caption=[
    "First memory ❤️",
    "One of my favourite moments ❤️",
    "A day I will always remember ❤️",
]

Windows paths

When using Windows paths in Python, raw strings such as r"C:\path\file.jpg" are useful because backslashes do not need to be escaped individually.

How EmotionWeb works.

At a high level, the package takes developer input, prepares the information required by the website, selects a template and generates the resulting web project.

The role of the generator

The package's generator layer acts as the central processing point for the website generation workflow. It receives the supplied information and coordinates the generation process.

Django

Django is part of the web engine used by EmotionWeb. Its template system provides the mechanism for inserting dynamic values into HTML templates.

Template rendering

A template can contain dynamic Django expressions such as and can iterate over collections such as images or captions.

Project structure.

EmotionWeb uses a package and web-engine structure to keep Python generation logic separate from website resources.

emotionweb/
├── generator.py
├── webengine/
│   ├── ...
│   └── static/
│       └── uploads/
└── ...

Template system.

Templates define the visual and structural experience produced for an occasion.

The important distinction is that the content is dynamic, while the template provides the website structure and presentation.

Dynamic name

Dynamic message

Image collection

Caption collection

Customization.

EmotionWeb separates personalized data from the website template so that the same generation interface can be used with different content.

Change the recipient

name="Your Name"

Change the message

message="Your personalized message"

Change the occasion

type="birthday"

Images and captions can similarly be replaced with your own collections.

Advanced usage.

Advanced users can work with the package's template and web-engine architecture to understand or extend generated experiences.

Template-driven development

A developer who wants to introduce a new website experience needs to understand the relationship between the occasion type, generator logic and Django template.

Extending the template collection

A new template generally requires more than simply creating an HTML file. The generator needs a way to recognize the corresponding occasion type and route the data to the intended template.

Troubleshooting.

ImportError

If Python cannot import EmotionWeb, verify that the package is installed in the Python environment being used to execute the program.

pip installation problems

Check the Python and pip installation being used by your terminal and ensure the package installation completes successfully.

Images are not appearing

Check that every supplied image path points to the intended file and that the file exists.

Captions are not displayed correctly

Verify that captions are supplied as a list and that the selected template actually uses the caption data.

Template selection

Check the exact value supplied to type. It must correspond to a supported template type in the installed EmotionWeb version.

Frequently asked questions.

Do I need to know Django?

No for basic usage. The main public interface is the Python Surprise class. Django becomes more relevant when working with the underlying generated web engine or templates.

Can I provide multiple images?

Yes. The images parameter accepts a list of image paths.

Can I provide multiple captions?

Yes. Captions are supplied through the caption list.

Can I create another theme?

The architecture is intended to be extensible, and additional templates can be introduced as the project evolves.

Does EmotionWeb generate the website from Python?

Yes. The package is designed to receive information through Python and generate the corresponding personalized website.

What is the simplest possible example?

from emotionweb import Surprise

s = Surprise(
    type="birthday",
    name="Aniket Vishwakarma",
    message="chal aaja ghumne chalte h",
    images=[],
    caption=[]
)

s.generate()