.. _l-modules: Modules ======= .. contents:: :local: :depth: 1 Summary +++++++ +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | module | truncated documentation | +====================================================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | :ref:`__init__ ` | module ``pyrsslocal`` Module *pyrsslocal*. Very slow server for RSS streams. :githublink:`%|py|7` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`__init__ ` | module ``pyrsslocal.cli`` Shortcuts to cli. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`__init__ ` | module ``pyrsslocal.xmlhelper`` Shortcuts to xmlhelper :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`__main__ ` | module ``pyrsslocal.__main__`` Implements command line ``python -m pyrsslocal ``. .. versionadded:: 0.9 :githublink:`%|py|8` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`aserver ` | module ``pyrsslocal.custom_server.aserver`` This modules contains a class which implements a simple server. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`download_helper ` | module ``pyrsslocal.helper.download_helper`` various function to get the content from a url :githublink:`%|py|6` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`html_parser_json ` | module ``pyrsslocal.xmlhelper.html_parser_json`` parsing HTML to convert it into JSON :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`html_script_parser ` | module ``pyrsslocal.simple_server.html_script_parser`` This modules contains a class which implements a simple server. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`html_string ` | module ``pyrsslocal.simple_server.html_string`` This module contains various string useful when a html page has to be produced. It contains the following variables: .. list-table:: :widths: auto :header-rows: 1 * - attribute - meaning * - html_header - a HTML header to use this way: html_header % (title, author, keywords) * - html_footr - a HTML footer :githublink:`%|py|11` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`merge_rss ` | module ``pyrsslocal.cli.merge_rss`` Manipulate :epkg:`RSS` streams. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`python_run ` | module ``pyrsslocal.helper.python_run`` contains functionalities to run a python script :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`rss_blogpost ` | module ``pyrsslocal.rss.rss_blogpost`` description of a blog post :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`rss_database ` | module ``pyrsslocal.rss.rss_database`` Description of a :epkg:`RSS` stream. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`rss_flask ` | module ``pyrsslocal.rss.rss_flask`` Uses `Flask `_ to build pages. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`rss_flask_helper ` | module ``pyrsslocal.rss.rss_flask_helper`` Helpers for ``rss_flask.py``. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`rss_helper ` | module ``pyrsslocal.rss.rss_helper`` Various function to automate the collection of blog posts. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`rss_simple_server ` | module ``pyrsslocal.rss.rss_simple_server`` This modules contains a class which implements a simple server. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`rss_stream ` | module ``pyrsslocal.rss.rss_stream`` Description of a RSS stream. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`search_engine ` | module ``pyrsslocal.helper.search_engine`` various function to get the content of a page, of a search page... :githublink:`%|py|6` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`simple_server_custom ` | module ``pyrsslocal.simple_server.simple_server_custom`` This modules contains a class which implements a simple server. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`subscription_helper ` | module ``pyrsslocal.helper.subscription_helper`` Various functions about subscriptions :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`xml_exceptions ` | module ``pyrsslocal.xmlhelper.xml_exceptions`` Exceptions raised by files in this folder. :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`xml_tree ` | module ``pyrsslocal.xmlhelper.xml_tree`` parsing XML :githublink:`%|py|6` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`xml_tree_node ` | module ``pyrsslocal.xmlhelper.xml_tree_node`` parsing XML :githublink:`%|py|5` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`xml_utils ` | module ``pyrsslocal.xmlhelper.xml_utils`` parsing XML :githublink:`%|py|6` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`xmlfilewalk ` | module ``pyrsslocal.xmlhelper.xmlfilewalk`` functions related to XML files representing objects :githublink:`%|py|6` | +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. toctree:: :maxdepth: 1 pyrsslocal/__init__ pyrsslocal/__main__ pyrsslocal/cli/__init__ pyrsslocal/cli/merge_rss pyrsslocal/custom_server/aserver pyrsslocal/helper/download_helper pyrsslocal/helper/python_run pyrsslocal/helper/search_engine pyrsslocal/helper/subscription_helper pyrsslocal/rss/rss_blogpost pyrsslocal/rss/rss_database pyrsslocal/rss/rss_flask pyrsslocal/rss/rss_flask_helper pyrsslocal/rss/rss_helper pyrsslocal/rss/rss_simple_server pyrsslocal/rss/rss_stream pyrsslocal/simple_server/html_script_parser pyrsslocal/simple_server/html_string pyrsslocal/simple_server/simple_server_custom pyrsslocal/xmlhelper/__init__ pyrsslocal/xmlhelper/html_parser_json pyrsslocal/xmlhelper/xml_exceptions pyrsslocal/xmlhelper/xml_tree pyrsslocal/xmlhelper/xml_tree_node pyrsslocal/xmlhelper/xml_utils pyrsslocal/xmlhelper/xmlfilewalk