collective.consent


Namecollective.consent JSON
Version 2.0b1 PyPI version JSON
download
home_pagehttps://pypi.python.org/pypi/collective.consent
SummaryProvides a functionality to ask users for consent to different topics.
upload_time2023-01-19 14:40:41
maintainer
docs_urlNone
authorMaik Derstappen
requires_python
licenseGPL version 2
keywords python plone
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ==================
collective.consent
==================

Provides a functionality to ask authenticated users for consent to different topics, before they can continue. One can add multiple consent items and define which user will have to give there consent based on there permission roles. Each of this users have to give the consent before they can continue to work.

.. figure:: collective.consent-demo.gif

   Demo

This is realized by viewlet which will check a list of consents for each user/consent_item combination and redirect the user to the consent item case they still have to give there consent.
`Soup <https://pypi.org/project/souper/>`_
Internally the consents are stored in a soup on the ConsentsContainer ('/consents') object.


Features
--------

- Allows you to add multiple consent items (documents).
- A consent item consists of a Title, Description, RichText and a custom button text.
- Also you can define an update period, when the user has to give the consent again.
- For every consent item one can choose the target permission roles and consent update period.
- Users are only ask for consent on published consent items.
- One can reset (invalidate) all existing consents for a consent item.


ToDo
----

- Support local roles, currently only if the user has global roles that match, she will see the consent note.
- Add a global list of consents, sorted per user (maybe)
- remove Anonymous from roles vocab, as we only support authenticated users
- allow users to remove there consent?
- list given consents on the user dashboard (action: my consents)


Installation
------------

Install collective.consent by adding it to your buildout::

    [buildout]

    ...

    eggs =
        collective.consent


and then running ``bin/buildout``, start Plone and activate the add-on in the add-on's control panel. Then add a ConsentContainer on the top-level (portal-root).


Thanks
------

Initial implementation by: Derico - https://derico.de
Sponsored by https://www.uni-giessen.de


Contributors
------------

- Maik Derstappen (MrTango) - md@derio.de


Contribute
----------

- Issue Tracker: https://github.com/collective/collective.consent/issues
- Source Code: https://github.com/collective/collective.consent


Support
-------

If you are having issues, please let us know.


License
-------

The project is licensed under the GPLv2.


Contributors
============

- Maik Derstappen, md@derico.de


Changelog
=========


2.0b1 (2023-01-19)
------------------

- Plone 6 compatibility
  [MrTango]


1.0b3 (2021-02-09)
------------------

- Fix permission on consent_item_consents view
  [MrTango]



1.0b2 (2019-11-19)
------------------

- add plone.app.contenttypes as dependency
  [MrTango]

- sync travis config with tox config
  [MrTango]

- remove plone.app.contenttypes dependency and define RichText field our self.
  [MrTango]

- Add some german translations
  [MrTango]

- Fix i18n domain, add styles, refacture views, exclude consents container from nav
  [MrTango]


1.0b1 (2019-05-16)
------------------

- Initial release.
  [MrTango]



            

Raw data

            {
    "_id": null,
    "home_page": "https://pypi.python.org/pypi/collective.consent",
    "name": "collective.consent",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "Python Plone",
    "author": "Maik Derstappen",
    "author_email": "md@derico.de",
    "download_url": "https://files.pythonhosted.org/packages/37/91/cba0f9ac931af8d9893caf31d74ff4dff4370503fd28fe42155684feccd0/collective.consent-2.0b1.tar.gz",
    "platform": null,
    "description": "==================\ncollective.consent\n==================\n\nProvides a functionality to ask authenticated users for consent to different topics, before they can continue. One can add multiple consent items and define which user will have to give there consent based on there permission roles. Each of this users have to give the consent before they can continue to work.\n\n.. figure:: collective.consent-demo.gif\n\n   Demo\n\nThis is realized by viewlet which will check a list of consents for each user/consent_item combination and redirect the user to the consent item case they still have to give there consent.\n`Soup <https://pypi.org/project/souper/>`_\nInternally the consents are stored in a soup on the ConsentsContainer ('/consents') object.\n\n\nFeatures\n--------\n\n- Allows you to add multiple consent items (documents).\n- A consent item consists of a Title, Description, RichText and a custom button text.\n- Also you can define an update period, when the user has to give the consent again.\n- For every consent item one can choose the target permission roles and consent update period.\n- Users are only ask for consent on published consent items.\n- One can reset (invalidate) all existing consents for a consent item.\n\n\nToDo\n----\n\n- Support local roles, currently only if the user has global roles that match, she will see the consent note.\n- Add a global list of consents, sorted per user (maybe)\n- remove Anonymous from roles vocab, as we only support authenticated users\n- allow users to remove there consent?\n- list given consents on the user dashboard (action: my consents)\n\n\nInstallation\n------------\n\nInstall collective.consent by adding it to your buildout::\n\n    [buildout]\n\n    ...\n\n    eggs =\n        collective.consent\n\n\nand then running ``bin/buildout``, start Plone and activate the add-on in the add-on's control panel. Then add a ConsentContainer on the top-level (portal-root).\n\n\nThanks\n------\n\nInitial implementation by: Derico - https://derico.de\nSponsored by https://www.uni-giessen.de\n\n\nContributors\n------------\n\n- Maik Derstappen (MrTango) - md@derio.de\n\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/collective/collective.consent/issues\n- Source Code: https://github.com/collective/collective.consent\n\n\nSupport\n-------\n\nIf you are having issues, please let us know.\n\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\n\nContributors\n============\n\n- Maik Derstappen, md@derico.de\n\n\nChangelog\n=========\n\n\n2.0b1 (2023-01-19)\n------------------\n\n- Plone 6 compatibility\n  [MrTango]\n\n\n1.0b3 (2021-02-09)\n------------------\n\n- Fix permission on consent_item_consents view\n  [MrTango]\n\n\n\n1.0b2 (2019-11-19)\n------------------\n\n- add plone.app.contenttypes as dependency\n  [MrTango]\n\n- sync travis config with tox config\n  [MrTango]\n\n- remove plone.app.contenttypes dependency and define RichText field our self.\n  [MrTango]\n\n- Add some german translations\n  [MrTango]\n\n- Fix i18n domain, add styles, refacture views, exclude consents container from nav\n  [MrTango]\n\n\n1.0b1 (2019-05-16)\n------------------\n\n- Initial release.\n  [MrTango]\n\n\n",
    "bugtrack_url": null,
    "license": "GPL version 2",
    "summary": "Provides a functionality to ask users for consent to different topics.",
    "version": "2.0b1",
    "split_keywords": [
        "python",
        "plone"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3791cba0f9ac931af8d9893caf31d74ff4dff4370503fd28fe42155684feccd0",
                "md5": "c3c4c1af9e5d05409ef0d5a822443585",
                "sha256": "779ed7e379d22757e2176ce7baf289aed79b8110c292c19025c306d7a56817d5"
            },
            "downloads": -1,
            "filename": "collective.consent-2.0b1.tar.gz",
            "has_sig": false,
            "md5_digest": "c3c4c1af9e5d05409ef0d5a822443585",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 32631,
            "upload_time": "2023-01-19T14:40:41",
            "upload_time_iso_8601": "2023-01-19T14:40:41.781103Z",
            "url": "https://files.pythonhosted.org/packages/37/91/cba0f9ac931af8d9893caf31d74ff4dff4370503fd28fe42155684feccd0/collective.consent-2.0b1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-19 14:40:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "collective.consent"
}
        
Elapsed time: 0.03436s