invenio-config-tuw


Nameinvenio-config-tuw JSON
Version 2023.2.12 PyPI version JSON
download
home_pagehttps://gitlab.tuwien.ac.at/fairdata/invenio-config-tuw
Summary"Invenio module containing some customizations and configuration for TU Wien."
upload_time2023-12-22 14:12:06
maintainer
docs_urlNone
authorTU Wien
requires_python>=3.7
licenseMIT
keywords invenio tu wien configuration
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ..
    Copyright (C) 2020-2022 TU Wien.

    Invenio-Config-TUW is free software; you can redistribute it and/or
    modify it under the terms of the MIT License; see LICENSE file for more
    details.

====================
 Invenio-Config-TUW
====================

Invenio module for tweaking InvenioRDM to the needs of TU Wien.

We use this module to customize the following:

* Permission policies
* OIDC authentication handling
* E-Mail notification on errors
* Configuration values


Details
=======

Permission policies
-------------------

Currently, we are still operating on a friendly-user basis.
That is, while we cannot lose any data that has been uploaded by our users, we do not
allow every registered user to create record drafts, upload data, or publish records
from the get-go.
Instead, we require users to have the ``trusted-user`` role in order to be able to
create record drafts and upload data.
Similarly, we have the ``trusted-publisher`` role as a requirement for publishing
records.
Generally, these roles have to be assigned to users manually by an administrator.

On the test system, we give out these permissions automatically if we detect that a
newly registered user is an employee of TU Wien.


OIDC authentication handling
----------------------------

Because we have some special requirements regarding the authentication and signup
process, we have customized some of the handler functions for the OAuth client
that's integrated in InvenioRDM.
These customizations are contained in the files in ``auth/``.


E-Mail notification on errors
-----------------------------

This module defines a custom log handler for error-level logs which sends out
notifications as e-mail to a set of configured recipient addresses.


Configuration values
--------------------

Last but not least, we also set some default configuration values for deployments
of InvenioRDM at TU Wien.
The relevant files here are ``config.py`` and ``ext.py``.

..
    Copyright (C) 2020-2023 TU Wien.

    Invenio Config TUW is free software; you can redistribute it and/or
    modify it under the terms of the MIT License; see LICENSE file for more
    details.

Changes
=======

Version 2023.2 (released 2023-04-24, updated 2023-12-22)


- v11 compat: Update permission policies and disable archive download
- Set affiliation (hard-coded) to TU Wien in `user.profile`
- Set a default template for the `description` metadata field
- Add a null check for the current_user in the logging formatter
- Prevent the logging formatter from blowing up outside of a request context
- Add utilities and a celery task for updating the `names` vocabulary with information from TISS
- Enable sending of registration mails
- Allow edits to owners of published records even if they only have `trusted-user` role
- Fix a typo in the config generated by the `TUWSSOSettingsHelper`
- Fix function to fetch user by username
- Add record curation preferences to user settings


Version 2023.1 (released 2023-01-13)

- Update definition of the default creator for new uploads


Version 2022.3 (released 2022-10-28, updated 2022-11-30)

- v10 compat: Discard imports of removed Admin/SuperUser generators
- Rework the initialization procedure used for some custom overrides
- Migrate from setup.py to setup.cfg
- Move Flask config override from Invenio-Theme-TUW to Invenio-Config-TUW
- Update "Terms of Use" link in registration form


Version 2022.2 (released 2022-07-19, updated 2022-10-22)

- v9 compat: Chase changes in Invenio-{Accounts,OAuthClient} 2.x
- v9 compat: Update permission policies
- v9 compat: Hack in permission policy for communities
- Refactor permissions and config
- Remove leftover views.py
- Set deposit form file size limits
- Fix permissions
- Reverse contents of CHANGES.rst (recent changes are shown on top)
- Attach SMTP error handler to the application in production mode
- Add custom logging formatter
- Auto-confirm newly registered users' e-mail addresses if ``SECURITY_CONFIRMABLE`` is ``False``
- Set default user preferences (``visibility=public``, ``email_visibility=restricted``)
- Set default value for ``version`` metadata to ``1.0.0``
- Add config item to put the system into "read-only mode"


Version 2022.1 (released 2022-03-23, updated 2022-04-06)

- Update permissions for creating and editing drafts
- Use the OAI metadata implementation from Invenio-RDM-Records
- Change the default file size and bucket quota limits to 75GB


Version 2021.2 (released 2021-12-07, updated 2021-12-20)

- Make ready for InvenioRDM v7
- Add requests permission policy
- Enforce a rate limit for HTTP requests
- Change method of overriding the record permission policy
- Add datacite and oai_datacite metadataPrefixes to the OAI endpoint


Version 2021.1 (released 2021-07-15)

- Initial public release.
- Update the list of citation styles

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.tuwien.ac.at/fairdata/invenio-config-tuw",
    "name": "invenio-config-tuw",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "invenio tu wien configuration",
    "author": "TU Wien",
    "author_email": "tudata@tuwien.ac.at",
    "download_url": "https://files.pythonhosted.org/packages/ae/fc/12c005305f482e1ad7c547da355012c7f381e202b5fa590c84f7553dd55d/invenio-config-tuw-2023.2.12.tar.gz",
    "platform": "any",
    "description": "..\n    Copyright (C) 2020-2022 TU Wien.\n\n    Invenio-Config-TUW is free software; you can redistribute it and/or\n    modify it under the terms of the MIT License; see LICENSE file for more\n    details.\n\n====================\n Invenio-Config-TUW\n====================\n\nInvenio module for tweaking InvenioRDM to the needs of TU Wien.\n\nWe use this module to customize the following:\n\n* Permission policies\n* OIDC authentication handling\n* E-Mail notification on errors\n* Configuration values\n\n\nDetails\n=======\n\nPermission policies\n-------------------\n\nCurrently, we are still operating on a friendly-user basis.\nThat is, while we cannot lose any data that has been uploaded by our users, we do not\nallow every registered user to create record drafts, upload data, or publish records\nfrom the get-go.\nInstead, we require users to have the ``trusted-user`` role in order to be able to\ncreate record drafts and upload data.\nSimilarly, we have the ``trusted-publisher`` role as a requirement for publishing\nrecords.\nGenerally, these roles have to be assigned to users manually by an administrator.\n\nOn the test system, we give out these permissions automatically if we detect that a\nnewly registered user is an employee of TU Wien.\n\n\nOIDC authentication handling\n----------------------------\n\nBecause we have some special requirements regarding the authentication and signup\nprocess, we have customized some of the handler functions for the OAuth client\nthat's integrated in InvenioRDM.\nThese customizations are contained in the files in ``auth/``.\n\n\nE-Mail notification on errors\n-----------------------------\n\nThis module defines a custom log handler for error-level logs which sends out\nnotifications as e-mail to a set of configured recipient addresses.\n\n\nConfiguration values\n--------------------\n\nLast but not least, we also set some default configuration values for deployments\nof InvenioRDM at TU Wien.\nThe relevant files here are ``config.py`` and ``ext.py``.\n\n..\n    Copyright (C) 2020-2023 TU Wien.\n\n    Invenio Config TUW is free software; you can redistribute it and/or\n    modify it under the terms of the MIT License; see LICENSE file for more\n    details.\n\nChanges\n=======\n\nVersion 2023.2 (released 2023-04-24, updated 2023-12-22)\n\n\n- v11 compat: Update permission policies and disable archive download\n- Set affiliation (hard-coded) to TU Wien in `user.profile`\n- Set a default template for the `description` metadata field\n- Add a null check for the current_user in the logging formatter\n- Prevent the logging formatter from blowing up outside of a request context\n- Add utilities and a celery task for updating the `names` vocabulary with information from TISS\n- Enable sending of registration mails\n- Allow edits to owners of published records even if they only have `trusted-user` role\n- Fix a typo in the config generated by the `TUWSSOSettingsHelper`\n- Fix function to fetch user by username\n- Add record curation preferences to user settings\n\n\nVersion 2023.1 (released 2023-01-13)\n\n- Update definition of the default creator for new uploads\n\n\nVersion 2022.3 (released 2022-10-28, updated 2022-11-30)\n\n- v10 compat: Discard imports of removed Admin/SuperUser generators\n- Rework the initialization procedure used for some custom overrides\n- Migrate from setup.py to setup.cfg\n- Move Flask config override from Invenio-Theme-TUW to Invenio-Config-TUW\n- Update \"Terms of Use\" link in registration form\n\n\nVersion 2022.2 (released 2022-07-19, updated 2022-10-22)\n\n- v9 compat: Chase changes in Invenio-{Accounts,OAuthClient} 2.x\n- v9 compat: Update permission policies\n- v9 compat: Hack in permission policy for communities\n- Refactor permissions and config\n- Remove leftover views.py\n- Set deposit form file size limits\n- Fix permissions\n- Reverse contents of CHANGES.rst (recent changes are shown on top)\n- Attach SMTP error handler to the application in production mode\n- Add custom logging formatter\n- Auto-confirm newly registered users' e-mail addresses if ``SECURITY_CONFIRMABLE`` is ``False``\n- Set default user preferences (``visibility=public``, ``email_visibility=restricted``)\n- Set default value for ``version`` metadata to ``1.0.0``\n- Add config item to put the system into \"read-only mode\"\n\n\nVersion 2022.1 (released 2022-03-23, updated 2022-04-06)\n\n- Update permissions for creating and editing drafts\n- Use the OAI metadata implementation from Invenio-RDM-Records\n- Change the default file size and bucket quota limits to 75GB\n\n\nVersion 2021.2 (released 2021-12-07, updated 2021-12-20)\n\n- Make ready for InvenioRDM v7\n- Add requests permission policy\n- Enforce a rate limit for HTTP requests\n- Change method of overriding the record permission policy\n- Add datacite and oai_datacite metadataPrefixes to the OAI endpoint\n\n\nVersion 2021.1 (released 2021-07-15)\n\n- Initial public release.\n- Update the list of citation styles\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "\"Invenio module containing some customizations and configuration for TU Wien.\"",
    "version": "2023.2.12",
    "project_urls": {
        "Homepage": "https://gitlab.tuwien.ac.at/fairdata/invenio-config-tuw"
    },
    "split_keywords": [
        "invenio",
        "tu",
        "wien",
        "configuration"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a15f263fbea76f572d10a23a9b98e4759de0b20ce1191fac3cede5ce4fd68a28",
                "md5": "da38857e45ca5cf8f8dc2a5272b706d5",
                "sha256": "45676baa34cadc06fec9d48440ac20c2214853e3f9eb299be901591a6785026c"
            },
            "downloads": -1,
            "filename": "invenio_config_tuw-2023.2.12-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "da38857e45ca5cf8f8dc2a5272b706d5",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7",
            "size": 32179,
            "upload_time": "2023-12-22T14:12:04",
            "upload_time_iso_8601": "2023-12-22T14:12:04.639755Z",
            "url": "https://files.pythonhosted.org/packages/a1/5f/263fbea76f572d10a23a9b98e4759de0b20ce1191fac3cede5ce4fd68a28/invenio_config_tuw-2023.2.12-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aefc12c005305f482e1ad7c547da355012c7f381e202b5fa590c84f7553dd55d",
                "md5": "bc1a1ff9f31953af945fbdf72b08e3b9",
                "sha256": "fc1a4b16e8ce4b699482bb7c83c1bae254e9cd751efa384bb82f5c5416287333"
            },
            "downloads": -1,
            "filename": "invenio-config-tuw-2023.2.12.tar.gz",
            "has_sig": false,
            "md5_digest": "bc1a1ff9f31953af945fbdf72b08e3b9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 37937,
            "upload_time": "2023-12-22T14:12:06",
            "upload_time_iso_8601": "2023-12-22T14:12:06.811167Z",
            "url": "https://files.pythonhosted.org/packages/ae/fc/12c005305f482e1ad7c547da355012c7f381e202b5fa590c84f7553dd55d/invenio-config-tuw-2023.2.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-22 14:12:06",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "invenio-config-tuw"
}
        
Elapsed time: 0.18381s