From a3dbf9cbe38f53739ebd996116fa5d73354a9472 Mon Sep 17 00:00:00 2001 From: truePhilipp Date: Thu, 2 May 2024 17:42:19 +0200 Subject: [PATCH] first commit --- .gitignore | 297 ++++++++++++++++++ LICENSE.txt | 21 ++ README.md | 0 html_to_django/__about__.py | 1 + html_to_django/__init__.py | 0 html_to_django/formatters/__init__.py | 4 + html_to_django/formatters/block_formatter.py | 8 + html_to_django/formatters/for_formatter.py | 8 + html_to_django/formatters/if_formatter.py | 26 ++ html_to_django/formatters/static_formatter.py | 8 + html_to_django/formatters/var_formatter.py | 13 + html_to_django/main.py | 19 ++ pyproject.toml | 43 +++ tests/__init__.py | 0 tests/test.html | 15 + tests/test_main.py | 8 + 16 files changed, 471 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 html_to_django/__about__.py create mode 100644 html_to_django/__init__.py create mode 100644 html_to_django/formatters/__init__.py create mode 100644 html_to_django/formatters/block_formatter.py create mode 100644 html_to_django/formatters/for_formatter.py create mode 100644 html_to_django/formatters/if_formatter.py create mode 100644 html_to_django/formatters/static_formatter.py create mode 100644 html_to_django/formatters/var_formatter.py create mode 100644 html_to_django/main.py create mode 100644 pyproject.toml create mode 100644 tests/__init__.py create mode 100644 tests/test.html create mode 100644 tests/test_main.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0b01067 --- /dev/null +++ b/.gitignore @@ -0,0 +1,297 @@ +# Created by https://www.toptal.com/developers/gitignore/api/python,pycharm+all,macos +# Edit at https://www.toptal.com/developers/gitignore?templates=python,pycharm+all,macos + +### macOS ### +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### macOS Patch ### +# iCloud generated files +*.icloud + +### PyCharm+all ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### PyCharm+all Patch ### +# Ignore everything but code style settings and run configurations +# that are supposed to be shared within teams. + +.idea/* + +!.idea/codeStyles +!.idea/runConfigurations + +### Python ### +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +### Python Patch ### +# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration +poetry.toml + +# ruff +.ruff_cache/ + +# LSP config files +pyrightconfig.json + +# End of https://www.toptal.com/developers/gitignore/api/python,pycharm+all,macos \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..9afd87e --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Philipp Mayr + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..e69de29 diff --git a/html_to_django/__about__.py b/html_to_django/__about__.py new file mode 100644 index 0000000..f102a9c --- /dev/null +++ b/html_to_django/__about__.py @@ -0,0 +1 @@ +__version__ = "0.0.1" diff --git a/html_to_django/__init__.py b/html_to_django/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/html_to_django/formatters/__init__.py b/html_to_django/formatters/__init__.py new file mode 100644 index 0000000..1486335 --- /dev/null +++ b/html_to_django/formatters/__init__.py @@ -0,0 +1,4 @@ +from . import for_formatter, if_formatter, var_formatter, block_formatter, static_formatter + + +formatters = [for_formatter, if_formatter, var_formatter, block_formatter, static_formatter] diff --git a/html_to_django/formatters/block_formatter.py b/html_to_django/formatters/block_formatter.py new file mode 100644 index 0000000..1d9363c --- /dev/null +++ b/html_to_django/formatters/block_formatter.py @@ -0,0 +1,8 @@ +from bs4 import BeautifulSoup + + +def format(soup: BeautifulSoup) -> None: + for element in soup.find_all(attrs={"dj-block": True}): + element.insert_before(f"{{% block {element.get("dj-block")} %}}") + element.insert_after("{% endblock %}") + element.unwrap() diff --git a/html_to_django/formatters/for_formatter.py b/html_to_django/formatters/for_formatter.py new file mode 100644 index 0000000..b7bc490 --- /dev/null +++ b/html_to_django/formatters/for_formatter.py @@ -0,0 +1,8 @@ +from bs4 import BeautifulSoup + + +def format(soup: BeautifulSoup) -> None: + for element in soup.find_all(attrs={"dj-for": True}): + element.insert_before(f"{{% for {element.get("dj-for")} %}}") + element.insert_after("{% endfor %}") + element.unwrap() diff --git a/html_to_django/formatters/if_formatter.py b/html_to_django/formatters/if_formatter.py new file mode 100644 index 0000000..c48493e --- /dev/null +++ b/html_to_django/formatters/if_formatter.py @@ -0,0 +1,26 @@ +from bs4 import BeautifulSoup + + +def format(soup: BeautifulSoup) -> None: + for element in soup.find_all(attrs={"dj-if": True}): + element.insert_before(f"{{% if {element.get("dj-if")} %}}") + + participating_blocks = [element] + + current_sibling = element.find_next_sibling() + while current_sibling is not None: + if current_sibling.has_attr("dj-elif"): + current_sibling.insert_before(f"{{% elif {current_sibling.get("dj-elif")} %}}") + participating_blocks.append(current_sibling) + current_sibling = current_sibling.find_next_sibling() + elif current_sibling.has_attr("dj-else"): + current_sibling.insert_before("{% else %}") + participating_blocks.append(current_sibling) + current_sibling = None + else: + current_sibling = None + + participating_blocks[-1].insert_after("{% endif %}") + + for block in participating_blocks: + block.unwrap() diff --git a/html_to_django/formatters/static_formatter.py b/html_to_django/formatters/static_formatter.py new file mode 100644 index 0000000..0f2c805 --- /dev/null +++ b/html_to_django/formatters/static_formatter.py @@ -0,0 +1,8 @@ +from bs4 import BeautifulSoup + + +def format(soup: BeautifulSoup) -> None: + for element in soup.find_all(attrs={"dj-static": True}): + tag, value = element.get("dj-static").split(";") + element[tag] = f"{{% static '{value}' %}}" + del element.attrs["dj-static"] diff --git a/html_to_django/formatters/var_formatter.py b/html_to_django/formatters/var_formatter.py new file mode 100644 index 0000000..3b2440a --- /dev/null +++ b/html_to_django/formatters/var_formatter.py @@ -0,0 +1,13 @@ +""" +Find tags with a "dj-var" attribute and replace its content with the +value enclosed in {{ }}. +""" + + +from bs4 import BeautifulSoup + + +def format(soup: BeautifulSoup) -> None: + for element in soup.find_all(attrs={"dj-var": True}): + element.string = f"{{{{ {element.get("dj-var")} }}}}" + del element.attrs["dj-var"] diff --git a/html_to_django/main.py b/html_to_django/main.py new file mode 100644 index 0000000..3aebe5a --- /dev/null +++ b/html_to_django/main.py @@ -0,0 +1,19 @@ +import bs4 +from .formatters import formatters + + +def main(): + with open("test.html", "r") as file: + soup = bs4.BeautifulSoup(file, "html.parser") + + for formatter in formatters: + formatter.format(soup) + + formatter = bs4.formatter.HTMLFormatter(indent=4) + with open("out.html", "w") as file: + file.write("{% load static %}\n") + file.write(soup.prettify(formatter=formatter)) + + +def command_entry(): + print("ok") diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..f8e525f --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,43 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "html_to_django" +dynamic = ["version"] +authors = [ + { name="Philipp Mayr", email="philipp@mayr.software" }, +] +description = "HTML to Django Converter" +readme = {file = "README.md", content-type = "text/markdown"} +license = {file = "LICENSE.txt"} +keywords = ["html", "django"] +requires-python = ">= 3.12" +classifiers = [ + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.12", + "Operating System :: OS Independent", + "License :: OSI Approved :: MIT License" +] +dependencies = [ + "beautifulsoup4==4.12.3", +] + +[project.optional-dependencies] +test = [ + "mypy==1.9.0", + "pycodestyle==2.11.1" +] +dev = [ + "hatch==1.10.0" +] + +[project.urls] +Homepage = "" +Issues = "" + +[project.scripts] +html_to_django = "html_to_django.main:command_entry" + +[tool.hatch.version] +path = "html_to_django/__about__.py" \ No newline at end of file diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test.html b/tests/test.html new file mode 100644 index 0000000..54df5de --- /dev/null +++ b/tests/test.html @@ -0,0 +1,15 @@ +
+
+

Test

+
+

Select Me

+
+
+

Else if

+
+
+

Else

+ +
+
+
\ No newline at end of file diff --git a/tests/test_main.py b/tests/test_main.py new file mode 100644 index 0000000..f27e5dd --- /dev/null +++ b/tests/test_main.py @@ -0,0 +1,8 @@ +from html_to_django import main +from unittest import TestCase + + +class TestTocHTMLParser(TestCase): + def test_command_entry(self): + main.command_entry() + self.assertEqual(0, 0)