astutus.web package

Submodules

astutus.web.app_pages module

astutus.web.app_pages.handle_astutus()
astutus.web.app_pages.handle_top()

app_page.route(‘/’)

astutus.web.doc_pages module

astutus.web.doc_pages.handle_doc_path(path)

doc_page.route(‘/astutus/doc/<path:path>’)

astutus.web.doc_pages.handle_genindex()
astutus.web.doc_pages.handle_modindex()
astutus.web.doc_pages.handle_searchindex_js()
astutus.web.doc_pages.handle_source_path(path)

doc_page.route(‘/astutus/source/<path:path>’)

astutus.web.doc_pages.handle_top_index()
astutus.web.doc_pages.handle_underscore_static_path(path)

doc_page.route(‘/astutus/doc/<path:path>’)

astutus.web.flask_app module

This module implements the Flask web application for the package.

The web application provides:

  • A server for the Sphinx generated documentation.

  • An HTML interface for interacting with the system.

  • A REST API for interacting with the system remotely

  • or locally for automation.

The handle routines are all Flask endpoints.

Maintainence note:

Include the app.route decorator in the docstrings for the handle routines.

astutus.web.flask_app.create_app_and_db()
astutus.web.flask_app.run_with_standard_options()
astutus.web.flask_app.tojson_pretty_jinja2_template_file(json_text)

astutus.web.log_pages module

astutus.web.log_pages.handle_log()
astutus.web.log_pages.handle_log_item(logger_name)

astutus.web.raspi_pages module

astutus.web.raspi_pages.display_raspi_find(*, search_result, filter)
astutus.web.raspi_pages.get_items_list()
astutus.web.raspi_pages.handle_raspi()
astutus.web.raspi_pages.handle_raspi_item(idx)
astutus.web.raspi_pages.handle_raspi_item_ifconfig(idx)
astutus.web.raspi_pages.handle_raspi_item_rest(idx)
astutus.web.raspi_pages.process_raspi_search_using_nmap(args)

astutus.web.usb_pages module

astutus.web.usb_pages.get_alias_path_item_list()
astutus.web.usb_pages.get_config_items_list()
astutus.web.usb_pages.handle_device_tree_item(path)
astutus.web.usb_pages.handle_label(path)
astutus.web.usb_pages.handle_usb()
astutus.web.usb_pages.handle_usb_alias()
astutus.web.usb_pages.handle_usb_alias_item(nodepath)
astutus.web.usb_pages.handle_usb_configuration()
astutus.web.usb_pages.handle_usb_configuration_item(nodeid)
astutus.web.usb_pages.handle_usb_device()
astutus.web.usb_pages.handle_usb_settings()
astutus.web.usb_pages.item_to_html(item, device_info_map)
astutus.web.usb_pages.tree_to_html(tree_dict, device_info_map)