HTML 2 Object

Tools to handle the CRUD of .html files as objects.

Install

pip install html2object

Functions

• Parse your html file

  html = open(<path>, "r").read("bin/gui/index.html")
  document = HtmlElement(html)
  

• Add attributes

  document.add_attribute("class", "flex pt-2")
  

• Add children

  p = HtmlElement(name="p").add_child("This is a text")
  document.add_child(p)
  

• Set new children

  p = HtmlElement(name="p").add_child("This is a text")
  document.set_children([p])
  

• Get element by id

  image = document.get_element_by_id("image_id")
  image.add_attribute("src", "image_url")
  

• Get elements by name

  images = document.get_elements_by_name("image")
  for image in images:
    url_list.append(image.get_attribute("src"))
  

• Get elements by class name

  theme_element = document.get_elements_by_class_name("radix-themes")
  for element in theme_element:
    print(f"Main color: {element.get_attribute('data-accent-color')}")
  

Usage

This project provides a way to manipulate HTML files and update them dynamically. Here's how you can use it:

First, import the necessary classes from this project:

from html2object import HtmlElement

read your html file and:

Create an HtmlElement()

html = open(<path>, "r").read("bin/gui/index.html")
document = HtmlElement(html)

Create scripts

update_script = HtmlElement(name="script").add_child(
    "setInterval(() => reload(), 1500);"
)
document.add_child(update_script)

Create a div

p = HtmlElement(name="p", id="textID").add_chil("Text")
div = HtmlElement(name="div").add_child(p)
document.add_child(div)

Use Document functions like JS

text_element = document.get_element_by_id("textID")
strong = HtmlElement(name="strong").add_child("Strong text")
text_element.set_child([strong, "No strong text"])

save the html file running

open(path, "w").write(str(document)).close()

Local setup

Instructions on how to install and set up your project. Include any dependencies that need to be installed.

1. Clone the repository
2. Navigate to the project directory:

cd html2object

3. Create a virtual environment (optional but recommended):

python3 -m venv venv

4. Activate the virtual environment:

• For Windows:

venv\Scripts\activate

• For macOS and Linux:

source venv/bin/activate

5. Install the project dependencies:

pip install -r requirements.txt

That's it! Your project should now be installed and ready to use.