Metadata-Version: 2.1
Name: visaplan.plone.infohubs
Version: 1.2.0.dev4
Summary: A mini language for reuse of information
Home-page: UNKNOWN
Author: Tobias Herp
Author-email: tobias.herp@visaplan.com
License: GPL version 2
Project-URL: Source, https://github.com/visaplan/plone.infohubs
Project-URL: Documentation, https://pypi.org/project/visaplan.plone.infohubs
Project-URL: Tracker, https://github.com/visaplan/plone.infohubs/issues
Description: .. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
           If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
           This text does not appear on pypi or github. It is a comment.
        
        .. image::
           https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
               :target: https://pycqa.github.io/isort/
        
        =======================
        visaplan.plone.infohubs
        =======================
        
        This product establishes a "mini language" for the calculation and re-use of
        information in Plone_ instances during the processing of a single request,
        e.g. when creating breadcrumbs; e.g., if the login state is important for the
        breadcrumb for ``/foo``, that same state might be important for the
        ``/foo/bar`` breadcrumb as well.
        
        It is part of the footing of the "Unitracc family" of Plone sites
        which are maintained by `visaplan GmbH`_, Bochum, Germany; the mini-language
        was established during the development of the now factored-out package
        ``visaplan.plone.breadcrumbs``.
        
        The purpose of this package (for now) is *not* to provide new functionality
        but to factor out existing functionality from our former monolithic Zope product.
        Thus, it is more likely to lose functionality during further development
        (as parts of it will be forked out into their own packages,
        or some functionality may even become obsolete because there are better
        alternatives in standard Plone components).
        
        
        Features
        --------
        
        - The ``info`` dictionary holds the collected information of interest
          during processing of the request.
        - The ``hub`` dictionary holds the tools which were used to get those
          information chunks.
        
          For some named tools, there are abbreviations available (e.g. ``pc`` for
          ``portal_catalog``), mostly for historical reasons.
        
        
        Examples
        --------
        
        This add-on can be seen in action at the following sites:
        
        - https://www.unitracc.de
        - https://www.unitracc.com
        
        
        Documentation
        -------------
        
        Full documentation for end users can be found in the "docs" folder.
        
        
        Installation and usage
        ----------------------
        
        Add ``visaplan.plone.infohubs`` to the requirements of your add-on.
        
        Then, in your own code::
        
            from visaplan.plone.infohubs import make_hubs
            ...
                # in some function or method where you have a meaningful context:
                hub, info = make_hubs(self.context)
                someval = info['some_known_key']
        
        While getting the information for the given key ``some_known_key``,
        the used tools will be stored in the ``hub`` dictionary,
        and other information found on the way will be stored in the ``info``
        dictionary.
        
        
        Contribute
        ----------
        
        - Issue Tracker: https://github.com/visaplan/visaplan.plone.infohubs/issues
        - Source Code: https://github.com/visaplan/visaplan.plone.infohubs
        
        
        Support
        -------
        
        If you are having issues, please let us know;
        please use the `issue tracker`_ mentioned above.
        
        
        License
        -------
        
        The project is licensed under the GPLv2.
        
        .. _`issue tracker`: https://github.com/visaplan/PACKAGE/issues
        .. _Plone: https://plone.org/
        .. _`visaplan GmbH`: http://visaplan.com
        
        .. vim: tw=79 cc=+1 sw=4 sts=4 si et
        
        
        Contributors
        ============
        
        - Tobias Herp, tobias.herp@visaplan.com
        
        
        Changelog
        =========
        
        
        1.2.0 (unreleased)
        ------------------
        
        New Features:
        
        - info key `my_translation`: a proxy to get the appropriate language version
          for an object given by `path` or `uid`
        
        Hard dependencies removed:
        
        +------------------------------+----------------------------------------+
        | Package                      | Depending features                     |
        +==============================+========================================+
        | visaplan.plone.groups_       | - ``info['group_title']``              |
        |                              | - ``info['gid']`` (group id)           |
        |                              | - ``info['managed_group_title']``      |
        |                              | - ``info['is_member_of'](`group`)``    |
        +------------------------------+----------------------------------------+
        | visaplan.plone.tools_        | - ``info['session']``                  |
        |                              | - ``info['gid']`` (group id)           |
        +------------------------------+----------------------------------------+
        | visaplan.plone.pdfexport     | - ``info['PDFCreator']``               |
        +------------------------------+----------------------------------------+
        | visaplan.plone.unitracctool  | - ``info['desktop_brain']``            |
        |                              | - ``info['desktop_url']``              |
        |                              | - ``info['bracket_default']``          |
        +------------------------------+----------------------------------------+
        
        [tobiasherp]
        
        
        1.1.0 (2020-07-15)
        ------------------
        
        New Features:
        
        - info key `my_translation`: a proxy to get the appropriate language version
          for an object given by `path` or `uid`
        
        [tobiasherp]
        
        
        1.0.2 (2019-05-09)
        ------------------
        
        - convenience function ``context_tuple``,
          e.g. for methods with optional ``hub`` and ``info`` arguments
        
        - Explicitly raise TypeErrors instead of using assertions
          (``context_and_form_tuple``, ``context_tuple``)
        
        - New info keys ``counter`` and ``counters``
        
        [tobiasherp]
        
        
        1.0.1 (2019-01-31)
        ------------------
        
        - ``info['my_uid']`` uses ``plone.uuid.interfaces.IUUID`` directly
          [tobiasherp]
        
        
        1.0 (2018-09-17)
        -----------------
        
        - Initial release.
          [tobiasherp]
        
        .. _visaplan.plone.groups: https://pypi.org/project/visaplan.plone.groups
        .. _visaplan.plone.tools: https://pypi.org/project/visaplan.plone.tools
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 4.3
Classifier: Framework :: Plone :: 5.0
Classifier: Framework :: Plone :: 5.1
Classifier: Framework :: Plone :: 5.2
Classifier: Framework :: Zope2
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: German
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Description-Content-Type: text/x-rst
