tts-html-utils 0.5.4__tar.gz

tts_html_utils-0.5.4/.gitignore

@@ -0,0 +1,180 @@
+# 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/
+
+env
+venv
+
+# IDEs and editors
+.idea/
+.vscode/
+*.sublime-project
+*.sublime-workspace
+
+# Jupyter notebooks
+.ipynb_checkpoints/
+
+# Jupyter lab workspace
+.jupyter/
+
+# Miscellaneous
+.DS_Store
+Thumbs.db
+._*

tts_html_utils-0.5.4/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: tts-html-utils
+Version: 0.5.4
+Summary: Utilities for simplifying HTML generation.
+Author: muszynsk
+Author-email: muszynsk <matt.muszynski@jpl.nasa.gov>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/NASA-JPL-Teamtools-Studio/html_utils
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: beautifulsoup4
+Requires-Dist: datetime
+Requires-Dist: django
+Requires-Dist: jinja2
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: plotly
+Requires-Dist: pytest
+Requires-Dist: tts-utilities<1.0.0,>=0.2.1
+Dynamic: author
+Dynamic: requires-python
+
+# HTML Utilities
+
+![Project logo](https://github.com/NASA-JPL-Teamtools-Studio/teamtools-documentation/blob/main/docs/images/tts_image_artifacts/html_utils.png)
+
+## About Teamtools Studio
+
+HTML Utilities is part of JPL's Teamtools Studio (TTS).
+
+TTS is an effort originated in JPL's Planning and Execution section to centralize shared repositories across missions. This benefits JPL by reducing cost through reducing duplicated code, collaborating across missions, and unifying standards for development and design across JPL.
+
+Although Planning and Execution is primarily concerned with flight operations, the TTS suite has been generalized and atomized to the point where many of these tools are applicable during other mission phases and even in non-spaceflight contexts. Through our work flying space missions, we hope to provide tools to the open source community that have utility in data analysis or planning for any complex system where failure is not an option.
+
+For more infomation on how to contribute, and how these libraries form a complete ecosystem for high reliability data analysis, see the [Full TTS Documentation](https://nasa-jpl-teamtools-studio.github.io//teamtools-documentation/).
+
+## What is HTML Utilities?
+
+### Overview
+
+HTML Utilities is what it says on the tin. While there are many HTML generating Pyhton libraries, the Teamtools Studio
+team noticed that many do not match the patterns expected by purely Python developers, resulting in many difficult to
+maintain HTML reporting tools. 
+
+This library is intended to be much more Pyhtonic and provide the ability to create somewhat sophisticated HTML reports
+with little specific web design knowledge. There is also some JavaScript embedded in some entities to enable a light level
+of interactivity needed for this work.
+
+This library uses components that look and feel more or less like Plotly Dash, but is not meant to necessarily be as
+sophisticated as that library, and unlike Plotly Dash, it is meant to be used as a standalone HTML report generation tool.
+
+While it certainly can be--and indeed is--used as a component in web applications, its primary use case is to create
+components to be incorporated into HTML-friendly applications like Confluence, or to just make custom reports as HTML files
+that can be easily shared via email or attaching to other reporting and project management tools like Jira.
+
+### Projects Currently Supported
+
+* Europa Clipper
+* Mars 2020/Perseverance
+* Mars Sample Return/Sample Retrieval Lander
+* Mars Science Laboratory/Curiosity
+* Mars Reconnaisance Orbiter
+* NISAR
+* Orbiting Carbon Observatory 2 (OCO-2)
+
+## Architecture
+
+### TTS dependencies
+
+* TTS Utilities

tts_html_utils-0.5.4/README.md

@@ -0,0 +1,48 @@
+# HTML Utilities
+
+![Project logo](https://github.com/NASA-JPL-Teamtools-Studio/teamtools-documentation/blob/main/docs/images/tts_image_artifacts/html_utils.png)
+
+## About Teamtools Studio
+
+HTML Utilities is part of JPL's Teamtools Studio (TTS).
+
+TTS is an effort originated in JPL's Planning and Execution section to centralize shared repositories across missions. This benefits JPL by reducing cost through reducing duplicated code, collaborating across missions, and unifying standards for development and design across JPL.
+
+Although Planning and Execution is primarily concerned with flight operations, the TTS suite has been generalized and atomized to the point where many of these tools are applicable during other mission phases and even in non-spaceflight contexts. Through our work flying space missions, we hope to provide tools to the open source community that have utility in data analysis or planning for any complex system where failure is not an option.
+
+For more infomation on how to contribute, and how these libraries form a complete ecosystem for high reliability data analysis, see the [Full TTS Documentation](https://nasa-jpl-teamtools-studio.github.io//teamtools-documentation/).
+
+## What is HTML Utilities?
+
+### Overview
+
+HTML Utilities is what it says on the tin. While there are many HTML generating Pyhton libraries, the Teamtools Studio
+team noticed that many do not match the patterns expected by purely Python developers, resulting in many difficult to
+maintain HTML reporting tools. 
+
+This library is intended to be much more Pyhtonic and provide the ability to create somewhat sophisticated HTML reports
+with little specific web design knowledge. There is also some JavaScript embedded in some entities to enable a light level
+of interactivity needed for this work.
+
+This library uses components that look and feel more or less like Plotly Dash, but is not meant to necessarily be as
+sophisticated as that library, and unlike Plotly Dash, it is meant to be used as a standalone HTML report generation tool.
+
+While it certainly can be--and indeed is--used as a component in web applications, its primary use case is to create
+components to be incorporated into HTML-friendly applications like Confluence, or to just make custom reports as HTML files
+that can be easily shared via email or attaching to other reporting and project management tools like Jira.
+
+### Projects Currently Supported
+
+* Europa Clipper
+* Mars 2020/Perseverance
+* Mars Sample Return/Sample Retrieval Lander
+* Mars Science Laboratory/Curiosity
+* Mars Reconnaisance Orbiter
+* NISAR
+* Orbiting Carbon Observatory 2 (OCO-2)
+
+## Architecture
+
+### TTS dependencies
+
+* TTS Utilities

tts_html_utils-0.5.4/ci/sphinx_ignore_tags.txt

@@ -0,0 +1,24 @@
+#When tts-build-sphinx-docs runs, it will collect all tags and branches and attempt to build
+#docs for each in the gh-pages branch. This is a config file that allows developers to 
+#specifically exclude any branches or tags they need. Each line is the name of a tag or 
+#branch.
+#
+#This file makes no attemtpt to tell whether a line is a tag or a branch as TTS assumes that
+#the naming conventions will always be different, and that tags should be tied to releases,
+#so they should always have semvar names, whereas branches should be more descriptive using
+#typical agile branch naming conventions.
+#
+#The most typical use case is to exclude tags that were created before you added the docs
+#prerequisites, or to exclude the gh-pages branch itself since no code is expected to live
+#there. All TTS repos are expected to have a gh-pages branch, but it is expected that it
+#will always be managed by tts-build-sphinx-docs. You do not need to manually create
+#a gh-pages branch because tts-build-sphinx-docs will create one if it does not exist.
+#
+#tts-build-sphinx-docs will also always remove all files from gh-pages and rebuild all docs
+#from scratch
+# Ignore all 0.x versions
+0\..*
+# Ignore v0.1.x and v0.2.x specifically
+v0\.[1-2]\..*
+# Ignore temporary feature branches
+gh-pages

tts_html_utils-0.5.4/docs/_static/bugfix.css

@@ -0,0 +1,12 @@
+/*
+Resolves a bug where the text in the header
+"[package name] [package version] documentation"
+was getting stacked up on top of itself when the variable portions were too long. Something with floats
+and elements not taking up the whole width of their contents.
+
+Needed to add it because setuptools-scm version names can be very long, especially for versions that
+are build off of a commit with no tag
+*/
+.navbar-header-items__start {
+    width: auto;
+}

tts_html_utils-0.5.4/docs/base.rst

@@ -0,0 +1,5 @@
+Base
+===============
+
+.. automodule:: html_utils.core.components.base
+   :members:

tts_html_utils-0.5.4/docs/compiler.rst

@@ -0,0 +1,5 @@
+Compiler
+===============
+
+.. automodule:: html_utils.core.compiler
+   :members:

tts_html_utils-0.5.4/docs/conf.py

@@ -0,0 +1,71 @@
+# TTS-specifc add ons
+from pathlib import Path
+from datetime import datetime
+from setuptools_scm import get_version
+import toml
+
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+
+import os
+import sys
+import importlib.metadata
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- Project information -----------------------------------------------------
+
+pyproject = toml.load(Path(__file__).parent.parent.joinpath("pyproject.toml"))
+project = pyproject["project"]["name"]
+release = get_version(root='..', relative_to=__file__)
+version = '.'.join(release.split('.')[:2])
+
+copyright = f"{datetime.now().strftime('%Y')} JPL"
+author = 'JPL Teamtools Studio'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The master toctree document.
+master_doc = 'index'
+
+pygments_style = 'sphinx'
+# html_theme = 'nature'
+# html_theme = 'sphinx_material'
+html_theme = 'pydata_sphinx_theme'
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+html_css_files = ['bugfix.css']
+html_copy_source = False
+html_show_sourcelink = False

tts_html_utils-0.5.4/docs/index.rst

@@ -0,0 +1,34 @@
+Welcome to the HTML Utils documentation!
+=============================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Base Classes:
+
+   base
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Superstructure Elements:
+
+   compiler
+
+.. toctree::
+   :maxdepth: 2
+   :caption: HTML Elements:
+
+   list
+   misc
+   navigation
+   plot
+   table
+   text
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

tts_html_utils-0.5.4/docs/list.rst

@@ -0,0 +1,5 @@
+List
+===============
+
+.. automodule:: html_utils.core.components.list
+   :members:

tts_html_utils-0.5.4/docs/misc.rst

@@ -0,0 +1,5 @@
+Misc
+===============
+
+.. automodule:: html_utils.core.components.misc
+   :members:

tts_html_utils-0.5.4/docs/navigation.rst

@@ -0,0 +1,5 @@
+Navigation
+===============
+
+.. automodule:: html_utils.core.components.navigation
+   :members:

tts_html_utils-0.5.4/docs/plot.rst

@@ -0,0 +1,5 @@
+Plot
+===============
+
+.. automodule:: html_utils.core.components.plot
+   :members:

tts_html_utils-0.5.4/docs/table.rst

@@ -0,0 +1,5 @@
+Table
+===============
+
+.. automodule:: html_utils.core.components.table
+   :members:

tts_html_utils-0.5.4/docs/text.rst

@@ -0,0 +1,5 @@
+Plot
+===============
+
+.. automodule:: html_utils.core.components.text
+   :members:

tts_html_utils-0.5.4/examples/README.md

@@ -0,0 +1,44 @@
+# HTML Utils Demos
+
+This directory contains demonstrations of various components and features of the `html_utils` package.
+
+## Available Demos
+
+### Nested Pane Containers
+
+The nested pane containers demo shows how to create pane containers that are nested inside other pane containers, with each container maintaining its own independent tabs and state.
+
+- **Python Script**: `nested_pane_containers_demo.py`
+- **Jupyter Notebook**: `nested_pane_containers_demo.ipynb`
+- **Output HTML**: `nested_pane_containers_demo.html` (generated when you run the script)
+
+To run the Python script demo:
+
+```bash
+cd /path/to/html_utils/demo
+python nested_pane_containers_demo.py
+```
+
+This will generate an HTML file and print its location. Open this file in a web browser to see the demo.
+
+To run the Jupyter notebook demo:
+
+```bash
+cd /path/to/html_utils/demo
+jupyter notebook nested_pane_containers_demo.ipynb
+```
+
+## Key Features Demonstrated
+
+1. **Custom IDs**: How to provide custom IDs for pane containers
+2. **Auto-generated IDs**: How containers generate unique IDs when none are provided
+3. **Nesting**: How to nest one pane container inside another
+4. **Independent State**: How each container maintains its own tab state
+
+## Adding New Demos
+
+When adding new demos to this directory, please follow these guidelines:
+
+1. Create both a Python script and a Jupyter notebook version if possible
+2. Include detailed comments and explanations
+3. Update this README with information about your demo

tts_html_utils-0.5.4/examples/debug_html_output.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+Debug script to print the exact HTML output of a PaneContainer
+"""
+
+import sys
+from pathlib import Path
+sys.path.insert(0, str(Path(__file__).parent.parent.parent))
+
+from tts_html_utils.core.components.structure import PaneContainer
+from tts_html_utils.core.components.misc import Div
+
+def main():
+    """Print the exact HTML output of a PaneContainer"""
+    pc = PaneContainer(id='pane-container-a')
+    pc.add_pane("Content A", "My Tab")
+    pc.add_pane("Content B", "Other Tab")
+    
+    html = pc.render()
+    
+    print("\nExact HTML output:")
+    print("=================")
+    print(html)
+    print("\nHTML output with line breaks for readability:")
+    print("===========================================")
+    # Add line breaks for readability
+    html_readable = html.replace("><", ">\n<")
+    print(html_readable)
+
+if __name__ == "__main__":
+    main()