ledoc-ui is a Python package that bundles static files for the 'livedoc' user interface. It acts as a convenient way to distribute the HTML, CSS, and JavaScript assets of the 'livedoc' UI, which is designed to display API documentation (often generated by frameworks like Spring). The package itself does not contain Python logic for UI generation or interaction but rather provides the front-end resources for a web application to serve. The current version is 0.1.0, and its release cadence appears irregular based on its minimal activity.
pip install ledoc-uiVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to serve the static web assets provided by `ledoc-ui` using the Flask web framework. The key is to locate the `static` directory within the installed `ledoc_ui` package and configure your web server to serve files from there. This example provides two routes: one for the main `index.html` and a catch-all for other static assets. Users would then navigate to the Flask application's root URL to access the `livedoc` UI in their browser.
Do not expect to import classes or functions directly from `ledoc_ui` to build a UI programmatically in Python. Instead, treat it as a resource folder for your web application.
Use `pkg_resources.resource_filename('ledoc_ui', 'static')` (as shown in the quickstart) for a robust way to find the static directory. Avoid hardcoding paths or relying solely on `__file__` based relative paths, as they can break once the package is installed.Do not try to import Python classes or functions from `ledoc_ui`. Instead, use `pkg_resources.resource_filename` to locate its static files and serve them via a web framework.
Ensure your web framework's static file serving routes are configured to cover all files within the `ledoc_ui/static` directory, not just `index.html`. Verify that the paths requested by the browser (seen in network tab) match the paths your server is exposing.
No dependency data recorded yet.
No resource links recorded.