Mercurial Repository: p/roundup/code: roundup/configuration.py comparison

comparison roundup/configuration.py @ 7371:a210f4437b49

Incomplete work to generate config doc from config.ini This is an incomplete attempt to allow generation of the config.ini documentation in reference.txt. It reformats the output of 'roundup_admin.py genconfig'. So it now includes all of the settings. Using a Makefile rule like: tracker_config.txt: ../roundup/configuration.py python3 ../roundup/scripts/roundup_admin.py \ genconfig _temp_config.txt sed -e '1,8d' \ -e 's/^\[\([a-z]*\)\]/\n.. index:: config.ini; sections \1\n\n.. code:: ini\n\n [\1]/' \ -e 's/^\([^[]\)/ \1/' \ _temp_config.txt > tracker_config.txt rm -f _temp_config.txt results in the config.ini split by section and index links being put in place. However some sections have a comment before the [section] marker. This comment is orphaned at the end of the prior section rather than starting the new section. A simple sed won't allow the lookahead needed to target the [section] marker and include the prior comment block. Also there are still have some long lines generated (> 65 characters). Maybe a python script can import configuration.py and output proper restructured text output? reference.txt: add a commented out include:: tracker_config.txt directive roundup/admin.py: don't require a tracker home for genconfig. So user can generate a clean config.ini on demand. Tracker home is still required for updateconfig. roundup/configuration.py: wrap lines better. A number of them are generating comments > 65 characters which is the targeted line length. This cleans up config.ini too, so is a good thing. website/www/conf.py: ignore doc/tracker_config.ini when processing.

author	John Rouillard <rouilj@ieee.org>
date	Wed, 17 May 2023 13:34:36 -0400
parents	ab0ea9f03866
children	bed28b64c581

comparison

equal deleted inserted replaced

-:f37c1df6de34
+:a210f4437b49
 class OriginHeadersListOption(Option):
 """List of space seperated origin header values.
 """
-class_description = "A list of space separated case sensitive origin headers 'scheme://host'."
+class_description = "A list of space separated case sensitive\norigin headers 'scheme://host'."
 def set(self, _val):
 pathlist = self._value = []
 for elem in _val.split():
 pathlist.append(elem)
 "If the sending user is \"Foo Bar\", the From: line\n"
 "is usually: \"Foo Bar\" <issue_tracker@tracker.example>\n"
 "the EMAIL_FROM_TAG goes inside the \"Foo Bar\" quotes like so:\n"
 "\"Foo Bar EMAIL_FROM_TAG\" <issue_tracker@tracker.example>"),
 (Option, "new_web_user_roles", "User",
-"Roles that a user gets when they register"
+"Roles that a user gets when they register\n"
-" with Web User Interface.\n"
+"with Web User Interface.\n"
-"This is a comma-separated string of role names"
+"This is a comma-separated string of role names\n"
 " (e.g. 'Admin,User')."),
 (Option, "new_email_user_roles", "User",
-"Roles that a user gets when they register"
+"Roles that a user gets when they register\n"
-" with Email Gateway.\n"
+"with Email Gateway.\n"
-"This is a comma-separated string of role names"
+"This is a comma-separated string of role names\n"
 " (e.g. 'Admin,User')."),
 (Option, "obsolete_history_roles", "Admin",
 "On schema changes, properties or classes in the history may\n"
 "become obsolete.  Since normal access permissions do not apply\n"
 "(we don't know if a user should see such a property or class)\n"
 "a list of roles is specified here that are allowed to see\n"
 "these obsolete properties in the history. By default only the\n"
 "admin role may see these history entries, you can make them\n"
 "visible to all users by adding, e.g., the 'User' role here."),
 (Option, "error_messages_to", "user",
-'Send error message emails to the "dispatcher", "user", '
+'Send error message emails to the "dispatcher", "user", \n'
 'or "both" (these are the three allowed values).\n'
-'The dispatcher is configured using the DISPATCHER_EMAIL'
+'The dispatcher is configured using the DISPATCHER_EMAIL\n'
 ' setting.'),
 (Option, "html_version", "html4",
 "HTML version to generate. The templates are html4 by default.\n"
-"If you wish to make them xhtml, then you'll need to change this\n"
+"If you wish to make them xhtml, then you'll need to change\n"
-"var to 'xhtml' too so all auto-generated HTML is compliant.\n"
+"this setting to 'xhtml' too so all auto-generated HTML\n"
+"is compliant.\n"
 "Allowed values: html4, xhtml"),
 (TimezoneOption, "timezone", TimezoneOption.defaulttz,
-"Default timezone offset,"
+"Default timezone offset,\n"
-" applied when user's timezone is not set.",
+"applied when user's timezone is not set.",
 ["DEFAULT_TIMEZONE"]),
 (BooleanOption, "instant_registration", "no",
 "Register new users instantly, or require confirmation via\n"
 "email?"),
 (BooleanOption, "email_registration_confirmation", "yes",
-"Offer registration confirmation by email or only through the web?"),
+"Offer registration confirmation by email or only\n"
+"through the web?"),
 (IndexerOption, "indexer", "",
 "Force Roundup to use a particular text indexer.\n"
 "If no indexer is supplied, the first available indexer\n"
 "will be used in the following order:\n"
 "Possible values: xapian, whoosh, native (internal), "
 ("tracker", (
 (Option, "name", "Roundup issue tracker",
 "A descriptive name for your roundup instance."),
 (WebUrlOption, "web", NODEFAULT,
 "The web address that the tracker is viewable at.\n"
-"This will be included in information"
+"This will be included in information\n"
-" sent to users of the tracker.\n"
+"sent to users of the tracker.\n"
 "The URL MUST include the cgi-bin part or anything else\n"
 "that is required to get to the home page of the tracker.\n"
 "URL MUST start with http/https scheme and end with '/'"),
 (MailAddressOption, "email", "issue_tracker",
 "Email address that mail to roundup should go to.\n"
 are logged into roundup and open a roundup link
 from a source other than roundup (e.g. link in
 email)."""),
 (BooleanOption, 'enable_xmlrpc', "yes",
 """Whether to enable the XMLRPC API in the roundup web
-interface. By default the XMLRPC endpoint is the string 'xmlrpc'
+interface. By default the XMLRPC endpoint is the string
-after the roundup web url configured in the 'tracker' section.
+'xmlrpc' after the roundup web url configured in the
-If this variable is set to 'no', the xmlrpc path has no special meaning
+'tracker' section. If this variable is set to 'no', the
-and will yield an error message."""),
+xmlrpc path has no special meaning and will yield an
+error message."""),
 (BooleanOption, 'translate_xmlrpc', 'no',
 """Whether to enable i18n for the xmlrpc endpoint. Enable it if
-you want to enable translation based on browsers lang (if enabled), trackers
+you want to enable translation based on browsers lang
-lang (if set) or environment."""),
+(if enabled), trackers lang (if set) or environment."""),
 (BooleanOption, 'enable_rest', "yes",
 """Whether to enable the REST API in the roundup web
-interface. By default the REST endpoint is the string 'rest' plus any
+interface. By default the REST endpoint is the string
-additional REST-API parameters after the roundup web url configured in
+'rest' plus any additional REST-API parameters after the
-the tracker section. If this variable is set to 'no', the rest path has
+roundup web url configured in the tracker section. If this
-no special meaning and will yield an error message."""),
+variable is set to 'no', the rest path has no special meaning
+and will yield an error message."""),
 (BooleanOption, 'translate_rest', 'no',
 """Whether to enable i18n for the rest endpoint. Enable it if
-you want to enable translation based on browsers lang (if enabled), trackers
+you want to enable translation based on browsers lang
-lang (if set) or environment."""),
+(if enabled), trackers lang (if set) or environment."""),
 (IntegerNumberGeqZeroOption, 'api_calls_per_interval', "0",
 "Limit API calls per api_interval_in_sec seconds to\n"
 "this number.\n"
 "Determines the burst rate and the rate that new api\n"
 "calls will be made available. If set to 360 and\n"
 (BooleanOption, "debug", "no",
 "Setting this option makes Roundup display error tracebacks\n"
 "in the user's browser rather than emailing them to the\n"
 "tracker admin."),
 (BooleanOption, "login_empty_passwords", "no",
-"Setting this option to yes/true allows users with an empty/blank\n"
+"Setting this option to yes/true allows users with\n"
-"password to login to the web/http interfaces."),
+"an empty/blank password to login to the\n"
+"web/http interfaces."),
 (BooleanOption, "migrate_passwords", "yes",
 "Setting this option makes Roundup migrate passwords with\n"
 "an insecure password-scheme to a more secure scheme\n"
 "when the user logs in via the web-interface."),
 (SecretMandatoryOption, "secret_key", create_token(),
 "Default: use a 30 second timeout (extraordinarily generous)\n"
 "Only used in SQLite connections."),
 (IntegerNumberGeqZeroOption, 'cache_size', '100',
 "Size of the node cache (in elements)"),
 (BooleanOption, "allow_create", "yes",
-"Setting this option to 'no' protects the database against table creations."),
+"Setting this option to 'no' protects the database against\n"
+"table creations."),
 (BooleanOption, "allow_alter", "yes",
-"Setting this option to 'no' protects the database against table alterations."),
+"Setting this option to 'no' protects the database against\n"
+"table alterations."),
 (BooleanOption, "allow_drop", "yes",
-"Setting this option to 'no' protects the database against table drops."),
+"Setting this option to 'no' protects the database against\n"
+"table drops."),
 (NullableOption, 'template', '',
 "Name of the PostgreSQL template for database creation.\n"
 "For database creation the template used has to match\n"
 "the character encoding used (UTF8), there are different\n"
 "PostgreSQL installations using different templates with\n"
 "http://www.postgresql.org/docs/9.1/static/transaction-iso.html"),
 (BooleanOption, "serverside_cursor", "yes",
 "Set the database cursor for filter queries to serverside\n"
 "cursor, this avoids caching large amounts of data in the\n"
 "client. This option only applies for the postgresql backend."),
-), "Settings in this section (except for backend) are used"
+), "Settings in this section (except for backend) are used\n"
 " by RDBMS backends only."
 ),
 ("sessiondb", (
 (SessiondbBackendOption, "backend", "",
 "Set backend for storing one time key (otk) and session data.\n"
 "(eg. iso-8859-1).",
 ["EMAIL_CHARSET"]),
 (FilePathOption, "debug", "",
 "Setting this option makes Roundup write all outgoing email\n"
 "messages to this file *instead* of sending them.\n"
-"This option has the same effect as environment variable"
+"This option has the same effect as the environment variable\n"
-" SENDMAILDEBUG.\nEnvironment variable takes precedence."),
+"SENDMAILDEBUG.\nEnvironment variable takes precedence."),
 (BooleanOption, "add_authorinfo", "yes",
 "Add a line with author information at top of all messages\n"
 "sent by roundup"),
 (BooleanOption, "add_authoremail", "yes",
-"Add the mail address of the author to the author information at\n"
+"Add the mail address of the author to the author information\n"
-"the top of all messages.\n"
+"at the top of all messages.\n"
 "If this is false but add_authorinfo is true, only the name\n"
 "of the actor is added which protects the mail address of the\n"
 "actor from being exposed at mail archives, etc."),
 ), "Outgoing email options.\n"
 "Used for nosy messages and approval requests"),

Mercurial > p > roundup > code

comparison roundup/configuration.py @ 7371:a210f4437b49