view doc/pydoc.txt @ 8487:b09ef85f0da6

feat: add nanoid pkg trace_id gen and decorator for setting processName nanoid is a shorter unique id generator and faster than uuid. I truncate nanoid id's to 12 chars to make it more readable. Also added decorator to allow setting the default processName definition in the logging module. admin.py and wsgi_handler now set processName. configuration.py knows how to overide the processName if set to the default MainProcess. Updated install docs to add nanoid as optional, how to switch to different trace_id output. pydoc generated docs include logcontext module and are referenced from admin.py.
author John Rouillard <rouilj@ieee.org>
date Mon, 08 Dec 2025 00:23:14 -0500
parents 0663a7bcef6c
children
line wrap: on
line source

================================
Embedded documentation from code
================================

.. contents::
   :local:

The following are embedded documentation selected from the Roundup
code base. You can see the same information using the ``help``
function after importing the modules.

Client class
============

.. autoclass:: roundup.cgi.client::Client
   :members:
   
CGI Action class
================

Action class and selected derived classes.

Action
------
.. autoclass:: roundup.cgi.actions::Action
   :members:

LoginAction
------------

.. autoclass:: roundup.cgi.actions::LoginAction
   :members:

.. _`ReauthAction_pydoc`:

ReauthAction
------------

.. autoclass:: roundup.cgi.actions::ReauthAction
   :members:
   
Templating Utils class
======================

.. autoclass:: roundup.cgi.templating::TemplatingUtils
   :members:

Logcontext Module
=================
.. _logcontext_pydoc:

.. automodule:: roundup.logcontext
   :members:
   :exclude-members: SimpleSentinel

Roundup Issue Tracker: http://roundup-tracker.org/