tcsenpai/Zundler
1
0
Fork 0
mirror of https://github.com/tcsenpai/Zundler.git synced 2025-06-07 03:55:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix setup cfg, rename directory, add 3rd party licenses

Browse Source
This commit is contained in:
Adrian Vollmer 2022-10-05 12:17:14 +02:00
parent 52eb8afc19
commit 0a82f2977c
15 changed files with 103 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -10,26 +10,39 @@ by taking the following approach:
* Embed all assets that are referenced in CSS files, such as imports and * Embed all assets that are referenced in CSS files, such as imports and
fonts fonts
* Endow all HTML files with extra scripts that embed these resources at run time: * Endow all HTML files with extra scripts that embed these resources at run time:
* Convert `script` tags with a `src` attribute referencing a JavaScript * Convert `script` tags with a `src` attribute referencing a local JavaScript file to inline scripts
file to inline scripts * Convert `link` tags with an `href` attribute referencing a local CSS file to inline styles
* Convert `link` tags with an `href` attribute referencing a CSS file to inline styles
* Make all `img` tags with a `src` attribute referencing local images use a data URI * Make all `img` tags with a `src` attribute referencing local images use a data URI
* Monkey patch the JavaScript function `fetch` and the class `URLSearchParams` * Monkey patch the JavaScript function `fetch` so requests to local files are turned into queries of the "virtual file tree" (see next item)
* Monkey patch the JavaScript class `URLSearchParams` so GET requests to
local files can be handeled; this is needed for Sphinx' search function, for example
* Create a JSON structure (the "global context") out of all files in the directory (the "virtual file tree") and other data * Create a JSON structure (the "global context") out of all files in the directory (the "virtual file tree") and other data
* Gzip this scructure and base64-encode it * Gzip the global context and base64-encode it
* Bundle it all into a scuffolding file with this structure: * Bundle it all into a scuffolding file with this structure:
```html ```html
<!DOCTYPE html> <!DOCTYPE html><html>
<html>
<head><style>{style}</style></head> <head><style>{style}</style></head>
<body>{body} <body>{body}
<script>window.global_context = {global_context}</script> <script>window.global_context = {zipped_global_context}</script>
<script>{pako} //# sourceURL=pako.js</script> <script>{pako} //# sourceURL=pako.js</script>
<script>{init_js} //# sourceURL=init.js</script> <script>{init_js} //# sourceURL=init.js</script>
</body></html> </body></html>
``` ```
The global context is then unzipped, an `iframe` is created and the The global context is then unzipped using the Pako library, an `iframe` is
document is bootstrapped from the virtual file tree. created and the document is bootstrapped from the virtual file tree.
The output file is usually smaller than the sum of all input files despite
some resources being embedded redundantly and the 33% overhead of the base64
encoding.
Limitations
-----------
This approach is quite hacky, but it might work well enough for some purposes.
Some scripts may break as the execution flow is different than some scripts
expect.
Installation Installation
@ -54,7 +67,7 @@ add a new builder. Similar to the `latexpdf`
Suggested Makefile addition: Suggested Makefile addition:
```make ```make
.PHONY: latexpdf .PHONY: zundler
latexpdf: latexpdf:
$(SPHINXBUILD) -b zundler $(ALLSPHINXOPTS) $(BUILDDIR)/html $(SPHINXBUILD) -b zundler $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo "Bundle asset into one self-contained HTML file..." @echo "Bundle asset into one self-contained HTML file..."
@ -68,11 +81,6 @@ Demos
... ...
Limitations
-----------
This approach is quite hacky, but it might work well enough for your
purposes.
Copyright Copyright

11
setup.cfg
View File

@ -1,5 +1,5 @@
[metadata] [metadata]
name = Zundler name = zundler
summary = Bundle assets of distributed HTML docs into one self-contained HTML file summary = Bundle assets of distributed HTML docs into one self-contained HTML file
description_file = README.md description_file = README.md
author = Adrian Vollmer author = Adrian Vollmer
@ -9,9 +9,8 @@ classifier =
Development Status :: 3 - Alpha Development Status :: 3 - Alpha
Environment :: Console Environment :: Console
Environment :: Web Environment Environment :: Web Environment
Framework :: Sphinx :: Extension
Intended Audience :: Developers Intended Audience :: Developers
License :: OSI Approved :: BSD License License :: OSI Approved :: MIT License
Operating System :: OS Independent Operating System :: OS Independent
Programming Language :: Python Programming Language :: Python
Programming Language :: Python :: 3 Programming Language :: Python :: 3
@ -20,7 +19,6 @@ classifier =
Programming Language :: Python :: 3.8 Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9 Programming Language :: Python :: 3.9
Topic :: Documentation Topic :: Documentation
Topic :: Documentation :: Sphinx
Topic :: Utilities Topic :: Utilities
[options] [options]
@ -34,10 +32,7 @@ install_requires =
[options.entry_points] [options.entry_points]
console_scripts = console_scripts =
zundler = src.__main__:main zundler = zundler.__main__:main
[files]
packages = src
[mypy] [mypy]
python_version = 3.8 python_version = 3.8

8
src/sphinxext/__init__.py
View File

@ -1,8 +0,0 @@
def setup(app):
app.add_config_value('html_embed_assets', False, 'html')
return {
'version': '0.1',
'parallel_read_safe': True,
'parallel_write_safe': True,
}

0
src/__init__.py → zundler/__init__.py
View File

0
src/__main__.py → zundler/__main__.py
View File

0
src/args.py → zundler/args.py
View File

52
zundler/assets/LICENSE Normal file
View File

@ -0,0 +1,52 @@
Zlib copyright notice:
(C) 1995-2013 Jean-loup Gailly and Mark Adler
Copyright (c) <''year''> <''copyright holders''>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
Jean-loup Gailly Mark Adler
jloup@gzip.org madler@alumni.caltech.edu
pako.js:
(The MIT License)
Copyright (C) 2014-2017 by Vitaly Puzrin and Andrei Tuputcyn
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.
Footer

0
src/assets/init.css → zundler/assets/init.css
View File

0
src/assets/init.html → zundler/assets/init.html
View File

0
src/assets/init.js → zundler/assets/init.js
View File

0
src/assets/inject.js → zundler/assets/inject.js
View File

0
src/assets/monkeypatch.js → zundler/assets/monkeypatch.js
View File

0
src/assets/pako.min.js → zundler/assets/pako.min.js vendored
View File

4
src/embed.py → zundler/embed.py
View File

@ -39,6 +39,7 @@ def embed_assets(index_file, output_path=None):
'init.html', 'init.html',
'monkeypatch.js', 'monkeypatch.js',
'pako.min.js', 'pako.min.js',
'LICENSE',
]: ]:
path = os.path.join(SCRIPT_PATH, 'assets', filename) path = os.path.join(SCRIPT_PATH, 'assets', filename)
init_files[filename] = open(path, 'r').read() init_files[filename] = open(path, 'r').read()
@ -77,13 +78,14 @@ def embed_assets(index_file, output_path=None):
<script>window.global_context = {global_context}</script> <script>window.global_context = {global_context}</script>
<script>{pako} //# sourceURL=pako.js</script> <script>{pako} //# sourceURL=pako.js</script>
<script>{init_js} //# sourceURL=init.js</script> <script>{init_js} //# sourceURL=init.js</script>
</body></html> </body><!-- {license} --></html>
""".format( """.format(
style=init_files['init.css'], style=init_files['init.css'],
init_js=init_files['init.js'], init_js=init_files['init.js'],
pako=init_files['pako.min.js'], pako=init_files['pako.min.js'],
body=init_files['init.html'], body=init_files['init.html'],
global_context=global_context, global_context=global_context,
license=init_files['LICENSE'],
) )
with open(output_path, 'w') as fp: with open(output_path, 'w') as fp:

21
zundler/sphinxext/__init__.py Normal file
View File

@ -0,0 +1,21 @@
from sphinx.builders.html import StandaloneHTMLBuilder
MAKEFILE = """
"""
class ZundlerBuilder(StandaloneHTMLBuilder):
def handle_finish(self) -> None:
super().handle_finish()
def setup(app):
app.add_config_value('html_embed_assets', False, 'html')
app.add_builder(ZundlerBuilder)
return {
'version': '0.1',
'parallel_read_safe': True,
'parallel_write_safe': True,
}