From 9d45c9d384200a294682486ccfc7278a1cd0ea18 Mon Sep 17 00:00:00 2001 From: Pingu Carsti Date: Fri, 12 Jul 2024 13:42:46 +0200 Subject: [PATCH 1/2] update changes --- CHANGES.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CHANGES.rst b/CHANGES.rst index 30aeec603..33e44e33a 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,6 +1,15 @@ Changes ******* +0.12.0 (2024-07-12) +=================== + +* add vagrant support (#212) +* added bbox (#213) +* customization for clint +* added matomo (#227) +* added imprint to footer (#228) + 0.11.0 (2020-02-04) =================== From b0aec50972524f60004a04a10b46dd3ef3de802e Mon Sep 17 00:00:00 2001 From: Pingu Carsti Date: Fri, 12 Jul 2024 13:45:48 +0200 Subject: [PATCH 2/2] update version --- docs/source/conf.py | 190 ++++++++++++++++++++++---------------------- phoenix/__init__.py | 47 ++++++----- 2 files changed, 123 insertions(+), 114 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 640223444..52fc8b46f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,51 +18,51 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +# sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '1.6' +needs_sphinx = "1.6" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.intersphinx', - 'sphinx.ext.todo', - 'sphinx.ext.viewcode', - 'sphinx.ext.napoleon', + "sphinx.ext.intersphinx", + "sphinx.ext.todo", + "sphinx.ext.viewcode", + "sphinx.ext.napoleon", # 'pywps.ext_autodoc', ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'Phoenix' -copyright = u'2020, Birdhouse' -author = u'Birdhouse' +project = "Phoenix" +copyright = "2024, Birdhouse" +author = "Birdhouse" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.11' +version = "0.12" # The full version, including alpha/beta/rc tags. -release = '0.11' +release = "0.12" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -73,9 +73,9 @@ # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -83,27 +83,27 @@ # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True @@ -113,158 +113,151 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'alabaster' +html_theme = "alabaster" # otherwise, readthedocs.org uses their theme by default, so no need to specify it # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' +# html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} +# html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' +# html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'projectdoc' +htmlhelp_basename = "projectdoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', - -# Latex figure (float) alignment -#'figure_align': 'htbp', + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + #'preamble': '', + # Latex figure (float) alignment + #'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'project.tex', u'Phoenix Documentation', - u'Birdhouse', 'manual'), + (master_doc, "project.tex", "Phoenix Documentation", "Birdhouse", "manual"), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'project', u'Phoenix Documentation', - [author], 1) -] +man_pages = [(master_doc, "project", "Phoenix Documentation", [author], 1)] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -273,41 +266,52 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'project', u'Phoenix Documentation', - author, 'project', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "project", + "Phoenix Documentation", + author, + "project", + "One line description of project.", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False # Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'https://docs.python.org/': None} -intersphinx_mapping = {'python': ('http://docs.python.org/', None), - 'birdhouse': ('http://birdhouse.readthedocs.io/en/latest/', None), - 'phoenix': ('http://pyramid-phoenix.readthedocs.io/en/latest/', None), - 'malleefowl': ('http://malleefowl.readthedocs.io/en/latest/', None), - 'twitcher': ('http://twitcher.readthedocs.io/en/latest/', None), - 'flyingpigeon': ('http://flyingpigeon.readthedocs.io/en/latest/', None), - 'hummingbird': ('http://birdhouse-hummingbird.readthedocs.io/en/latest/', None), - 'emu': ('http://emu.readthedocs.io/en/latest/', None), - 'birdy': ('http://birdy.readthedocs.io/en/latest/', None), - 'bootstrap': ('http://birdhousebuilderbootstrap.readthedocs.io/en/latest/', None), - } +# intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = { + "python": ("http://docs.python.org/", None), + "birdhouse": ("http://birdhouse.readthedocs.io/en/latest/", None), + "phoenix": ("http://pyramid-phoenix.readthedocs.io/en/latest/", None), + "malleefowl": ("http://malleefowl.readthedocs.io/en/latest/", None), + "twitcher": ("http://twitcher.readthedocs.io/en/latest/", None), + "flyingpigeon": ("http://flyingpigeon.readthedocs.io/en/latest/", None), + "hummingbird": ("http://birdhouse-hummingbird.readthedocs.io/en/latest/", None), + "emu": ("http://emu.readthedocs.io/en/latest/", None), + "birdy": ("http://birdy.readthedocs.io/en/latest/", None), + "bootstrap": ("http://birdhousebuilderbootstrap.readthedocs.io/en/latest/", None), +} # linkcheck options # http://www.sphinx-doc.org/en/stable/config.html?highlight=linkchecker#options-for-the-linkcheck-builder -linkcheck_ignore = [r'http[s]*://localhost.*/', 'https://mouflon.dkrz.de/', 'https://esgf-data.dkrz.de/', 'https://indico.egi.eu/'] +linkcheck_ignore = [ + r"http[s]*://localhost.*/", + "https://esgf-data.dkrz.de/", + "https://indico.egi.eu/", +] linkcheck_timeout = 15 # Link references always present on RST page. diff --git a/phoenix/__init__.py b/phoenix/__init__.py index f6b023332..2def4aa80 100644 --- a/phoenix/__init__.py +++ b/phoenix/__init__.py @@ -1,4 +1,4 @@ -__version__ = '0.11.0' +__version__ = "0.12.0" def main(global_config, **settings): @@ -10,62 +10,63 @@ def main(global_config, **settings): config = Configurator(settings=settings, autocommit=False) # security - config.include('phoenix.security') + config.include("phoenix.security") # beaker session - config.include('pyramid_beaker') + config.include("pyramid_beaker") # chameleon templates - config.include('pyramid_chameleon') + config.include("pyramid_chameleon") # deform # config.include('pyramid_deform') # config.include('js.deform') # celery - config.include('pyramid_celery') - config.configure_celery(global_config['__file__']) + config.include("pyramid_celery") + config.configure_celery(global_config["__file__"]) # static views (stylesheets etc) - config.add_static_view('static', 'static') - config.add_static_view('static_deform', 'deform:static') + config.add_static_view("static", "static") + config.add_static_view("static_deform", "deform:static") # database # TODO: overwrite request.db from twitcher # See: http://docs.pylonsproject.org/projects/pyramid/en/latest/api/config.html # config.include('phoenix.db') from phoenix.db import includeme as include_db + include_db(config) # routes - config.add_route('home', '/') + config.add_route("home", "/") # storage - config.include('phoenix.storage') + config.include("phoenix.storage") # settings - config.include('phoenix.settings') + config.include("phoenix.settings") # account - config.include('phoenix.account') + config.include("phoenix.account") # dashboard - config.include('phoenix.dashboard') + config.include("phoenix.dashboard") # processes - config.include('phoenix.processes') + config.include("phoenix.processes") # job monitor - config.include('phoenix.monitor') + config.include("phoenix.monitor") # user profiles - config.include('phoenix.people') + config.include("phoenix.people") # catalog - config.include('phoenix.catalog') + config.include("phoenix.catalog") # service settings - config.include('phoenix.services') + config.include("phoenix.services") # readthedocs # config.add_route('readthedocs', 'https://pyramid-phoenix.readthedocs.org/') @@ -73,31 +74,35 @@ def main(global_config, **settings): # max file size for upload in MB def max_file_size(request): settings = request.registry.settings - return int(settings.get('phoenix.max_file_size', '200')) + return int(settings.get("phoenix.max_file_size", "200")) + config.add_request_method(max_file_size, reify=True) # use json_adapter for datetime # http://docs.pylonsproject.org/projects/pyramid/en/1.5-branch/narr/renderers.html#json-renderer from pyramid.renderers import JSON import datetime + json_renderer = JSON() def datetime_adapter(obj, request): return obj.isoformat() + json_renderer.add_adapter(datetime.datetime, datetime_adapter) import bson def objectid_adapter(obj, request): return str(obj) + json_renderer.add_adapter(bson.objectid.ObjectId, objectid_adapter) # def wpsexception_adapter(obj, request): # logger.debug("mongo adapter wpsexception called") # return '%s %s: %s' % (obj.code, obj.locator, obj.text) # from owslib import wps # json_renderer.add_adapter(wps.WPSException, wpsexception_adapter) - config.add_renderer('json', json_renderer) + config.add_renderer("json", json_renderer) - config.scan('phoenix') + config.scan("phoenix") # enable autocommit config.autocommit = True