From b6cbd03f9ca9aeaedc6aa749f6c1fd435911178f Mon Sep 17 00:00:00 2001 From: Cian Hughes Date: Fri, 25 Apr 2025 15:31:24 +0100 Subject: [PATCH] Changed names for new fork --- .editorconfig | 2 +- .github/workflows/pypi-publish.yml | 2 +- .github/workflows/tests.yml | 8 ++-- AUTHORS.rst | 8 ++-- CHANGES.rst | 4 +- CONTRIBUTING.rst | 18 ++++----- INSTALL.rst | 4 +- MANIFEST.in | 22 +++++------ README.rst | 34 ++++++++--------- babel.ini | 2 +- docs/Makefile | 8 ++-- docs/api.rst | 4 +- docs/authors.rst | 2 +- docs/changes.rst | 2 +- docs/conf.py | 32 ++++++++-------- docs/configuration.rst | 4 +- docs/contributing.rst | 2 +- docs/index.rst | 4 +- docs/installation.rst | 2 +- docs/make.bat | 4 +- docs/usage.rst | 4 +- .../__init__.py | 8 ++-- .../config.py | 24 ++++++------ .../custom_fields/__init__.py | 2 +- .../ext.py | 14 +++---- .../permissions/__init__.py | 6 +-- .../permissions/generators.py | 14 +++---- .../permissions/policies.py | 22 +++++------ .../permissions/roles.py | 8 ++-- .../access_right/access_right.csv | 0 .../access_right/access_right_limit.csv | 0 ...tory_General_Data_Protection_Rights_de.pdf | Bin ...tory_General_Data_Protection_Rights_en.pdf | Bin .../TUGraz_Repository_Guide_01_de.pdf | Bin .../TUGraz_Repository_Guide_01_en.pdf | Bin .../TUGraz_Repository_Guide_02.1_de.pdf | Bin .../TUGraz_Repository_Guide_02.1_en.pdf | Bin .../TUGraz_Repository_Guide_02_de.pdf | Bin .../TUGraz_Repository_Guide_02_en.pdf | Bin ...raz_Repository_Terms_And_Conditions_de.pdf | Bin ...raz_Repository_Terms_And_Conditions_en.pdf | Bin .../templates/security/email/welcome.txt | 6 +-- .../translations/.gitkeep | 0 .../translations/de/LC_MESSAGES/messages.po | 35 +++++++++-------- .../translations/messages.pot | 35 +++++++++-------- .../utils.py | 22 +++++------ .../views.py | 18 ++++----- run-tests.sh | 2 +- setup.cfg | 36 +++++++++--------- setup.py | 4 +- tests/conftest.py | 6 +-- tests/test_invenio_config_tugraz.py | 16 ++++---- tests/test_policies.py | 36 +++++++++--------- 53 files changed, 243 insertions(+), 243 deletions(-) rename {invenio_config_tugraz => invenio_config_iform}/__init__.py (63%) rename {invenio_config_tugraz => invenio_config_iform}/config.py (95%) rename {invenio_config_tugraz => invenio_config_iform}/custom_fields/__init__.py (82%) rename {invenio_config_tugraz => invenio_config_iform}/ext.py (81%) rename {invenio_config_tugraz => invenio_config_iform}/permissions/__init__.py (57%) rename {invenio_config_tugraz => invenio_config_iform}/permissions/generators.py (94%) rename {invenio_config_tugraz => invenio_config_iform}/permissions/policies.py (89%) rename {invenio_config_tugraz => invenio_config_iform}/permissions/roles.py (65%) rename {invenio_config_tugraz => invenio_config_iform}/restrictions/access_right/access_right.csv (100%) rename {invenio_config_tugraz => invenio_config_iform}/restrictions/access_right/access_right_limit.csv (100%) rename {invenio_config_tugraz => invenio_config_iform}/static/documents/TUGraz_Repository_General_Data_Protection_Rights_de.pdf (100%) rename {invenio_config_tugraz => invenio_config_iform}/static/documents/TUGraz_Repository_General_Data_Protection_Rights_en.pdf (100%) rename {invenio_config_tugraz => invenio_config_iform}/static/documents/TUGraz_Repository_Guide_01_de.pdf (100%) rename {invenio_config_tugraz => invenio_config_iform}/static/documents/TUGraz_Repository_Guide_01_en.pdf (100%) rename {invenio_config_tugraz => invenio_config_iform}/static/documents/TUGraz_Repository_Guide_02.1_de.pdf (100%) rename {invenio_config_tugraz => invenio_config_iform}/static/documents/TUGraz_Repository_Guide_02.1_en.pdf (100%) rename {invenio_config_tugraz => invenio_config_iform}/static/documents/TUGraz_Repository_Guide_02_de.pdf (100%) rename {invenio_config_tugraz => invenio_config_iform}/static/documents/TUGraz_Repository_Guide_02_en.pdf (100%) rename {invenio_config_tugraz => invenio_config_iform}/static/documents/TUGraz_Repository_Terms_And_Conditions_de.pdf (100%) rename {invenio_config_tugraz => invenio_config_iform}/static/documents/TUGraz_Repository_Terms_And_Conditions_en.pdf (100%) rename {invenio_config_tugraz => invenio_config_iform}/templates/security/email/welcome.txt (86%) rename {invenio_config_tugraz => invenio_config_iform}/translations/.gitkeep (100%) rename {invenio_config_tugraz => invenio_config_iform}/translations/de/LC_MESSAGES/messages.po (63%) rename {invenio_config_tugraz => invenio_config_iform}/translations/messages.pot (54%) rename {invenio_config_tugraz => invenio_config_iform}/utils.py (68%) rename {invenio_config_tugraz => invenio_config_iform}/views.py (75%) diff --git a/.editorconfig b/.editorconfig index a35c89d..4234aae 100644 --- a/.editorconfig +++ b/.editorconfig @@ -2,7 +2,7 @@ # # Copyright (C) 2020 Mojib Wali. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. diff --git a/.github/workflows/pypi-publish.yml b/.github/workflows/pypi-publish.yml index 84decf9..64520b6 100644 --- a/.github/workflows/pypi-publish.yml +++ b/.github/workflows/pypi-publish.yml @@ -5,5 +5,5 @@ on: jobs: build-n-publish: - uses: tu-graz-library/.github/.github/workflows/pypi-publish.yml@main + uses: Cian-H/.github/.github/workflows/pypi-publish.yml@main secrets: inherit diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 4f1a622..f42c225 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -7,14 +7,14 @@ on: branches: master schedule: # * is a special character in YAML so you have to quote this string - - cron: '0 3 * * 6' + - cron: "0 3 * * 6" workflow_dispatch: inputs: reason: - description: 'Reason' + description: "Reason" required: false - default: 'Manual trigger' + default: "Manual trigger" jobs: tests: - uses: tu-graz-library/.github/.github/workflows/tests.yml@main + uses: Cian-H/.github/.github/workflows/tests.yml@main diff --git a/AUTHORS.rst b/AUTHORS.rst index cc621a1..f8961b4 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -1,13 +1,15 @@ .. Copyright (C) 2020 Mojib Wali. - invenio-config-tugraz is free software; you can redistribute it and/or + invenio-config-iform is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details. Authors ======= -invenio module that adds tugraz configs. +invenio module that adds I-Form configs. -- Mojib Wali +- Cian Hughes + +Forked from https://github.com/tu-graz-library/invenio-theme-tugraz diff --git a/CHANGES.rst b/CHANGES.rst index 36dfeb1..9a65962 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,7 +1,7 @@ .. Copyright (C) 2020 - 2022 Graz University of Technology. - invenio-config-tugraz is free software; you can redistribute it and/or + invenio-config-iform is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details. @@ -15,7 +15,7 @@ Version v0.12.5 (release 2024-07-29) Version v0.12.3 (release 2024-07-25) -- fix(tugraz_authenticated): missmatch of role name +- fix(iform_authenticated): missmatch of role name Version v0.12.2 (release 2024-07-19) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4e8e7bd..af7af82 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -10,7 +10,7 @@ Types of Contributions Report Bugs ~~~~~~~~~~~ -Report bugs at https://github.com/tu-graz-library/invenio-config-tugraz/issues. +Report bugs at https://github.com/Cian-H/invenio-config-iform/issues. If you are reporting a bug, please include: @@ -33,15 +33,15 @@ is open to whoever wants to implement it. Write Documentation ~~~~~~~~~~~~~~~~~~~ -invenio-config-tugraz could always use more documentation, whether as part of the -official invenio-config-tugraz docs, in docstrings, or even on the web in blog posts, +invenio-config-iform could always use more documentation, whether as part of the +official invenio-config-iform docs, in docstrings, or even on the web in blog posts, articles, and such. Submit Feedback ~~~~~~~~~~~~~~~ The best way to send feedback is to file an issue at -https://github.com/tu-graz-library/invenio-config-tugraz/issues. +https://github.com/Cian-H/invenio-config-iform/issues. If you are proposing a feature: @@ -53,14 +53,14 @@ If you are proposing a feature: Get Started! ------------ -Ready to contribute? Here's how to set up `invenio-config-tugraz` for local development. +Ready to contribute? Here's how to set up `invenio-config-iform` for local development. 1. Fork the `https://github.com/https://github.com/mb-` repo on GitHub. 2. Clone your fork locally: .. code-block:: console - $ git clone git@github.com:your_name_here/invenio-config-tugraz.git + $ git clone git@github.com:your_name_here/invenio-config-iform.git 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local @@ -68,8 +68,8 @@ Ready to contribute? Here's how to set up `invenio-config-tugraz` for local deve .. code-block:: console - $ mkvirtualenv invenio-config-tugraz - $ cd invenio-config-tugraz/ + $ mkvirtualenv invenio-config-iform + $ cd invenio-config-iform/ $ pip install -e .[all] 4. Create a branch for local development: @@ -114,5 +114,5 @@ Before you submit a pull request, check that it meets these guidelines: 2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring. 3. The pull request should work for Python 3.6 and 3.7. Check - https://github.com/github/tu-graz-library/invenio-config-tugraz//actions?query=event%3Apull_request + https://github.com/github/Cian-H/invenio-config-iform//actions?query=event%3Apull_request and make sure that the tests pass for all supported Python versions. diff --git a/INSTALL.rst b/INSTALL.rst index 39ba36b..7f98ee1 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -1,8 +1,8 @@ Installation ============ -invenio-config-tugraz is on PyPI so all you need is: +invenio-config-iform is on PyPI so all you need is: .. code-block:: console - $ pip install invenio-config-tugraz + $ pip install invenio-config-iform diff --git a/MANIFEST.in b/MANIFEST.in index 62b9f26..52ed3ca 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -2,7 +2,7 @@ # # Copyright (C) 2020 Mojib Wali. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. @@ -18,7 +18,7 @@ include .dockerignore include .editorconfig include .tx/config prune docs/_build -recursive-include invenio_config_tugraz/translations *.po *.pot *.mo +recursive-include invenio_config_iform/translations *.po *.pot *.mo # added by check_manifest.py include *.md @@ -38,18 +38,18 @@ recursive-include tests *.py # added by check_manifest.py -recursive-include invenio_config_tugraz *.crt -recursive-include invenio_config_tugraz *.json -recursive-include invenio_config_tugraz *.key -recursive-include invenio_config_tugraz *.xml -recursive-include invenio_config_tugraz *.gitkeep -recursive-include invenio_config_tugraz *.txt -recursive-include invenio_config_tugraz *.html +recursive-include invenio_config_iform *.crt +recursive-include invenio_config_iform *.json +recursive-include invenio_config_iform *.key +recursive-include invenio_config_iform *.xml +recursive-include invenio_config_iform *.gitkeep +recursive-include invenio_config_iform *.txt +recursive-include invenio_config_iform *.html # added by check-manifest -recursive-include invenio_config_tugraz *.csv +recursive-include invenio_config_iform *.csv # added by check-manifest -recursive-include invenio_config_tugraz *.pdf +recursive-include invenio_config_iform *.pdf include .git-blame-ignore-revs diff --git a/README.rst b/README.rst index fc7d044..a552329 100644 --- a/README.rst +++ b/README.rst @@ -1,36 +1,36 @@ .. Copyright (C) 2020-2021 Graz University of Technology. - invenio-config-tugraz is free software; you can redistribute it and/or + invenio-config-iform 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-tugraz + invenio-config-iform ======================= -.. image:: https://github.com/tu-graz-library/invenio-config-tugraz/workflows/CI/badge.svg - :target: https://github.com/tu-graz-library/invenio-config-tugraz/actions +.. image:: https://github.com/Cian-H/invenio-config-iform/workflows/CI/badge.svg + :target: https://github.com/Cian-H/invenio-config-iform/actions -.. image:: https://img.shields.io/pypi/dm/invenio-config-tugraz.svg - :target: https://pypi.python.org/pypi/invenio-config-tugraz +.. image:: https://img.shields.io/pypi/dm/invenio-config-iform.svg + :target: https://pypi.python.org/pypi/invenio-config-iform -.. image:: https://img.shields.io/github/tag/tu-graz-library/invenio-config-tugraz.svg - :target: https://github.com/tu-graz-library/invenio-config-tugraz/releases +.. image:: https://img.shields.io/github/tag/Cian-H/invenio-config-iform.svg + :target: https://github.com/Cian-H/invenio-config-iform/releases -.. image:: https://img.shields.io/github/license/tu-graz-library/invenio-config-tugraz.svg - :target: https://github.com/tu-graz-library/invenio-config-tugraz/blob/master/LICENSE +.. image:: https://img.shields.io/github/license/Cian-H/invenio-config-iform.svg + :target: https://github.com/Cian-H/invenio-config-iform/blob/master/LICENSE -.. image:: https://readthedocs.org/projects/invenio-config-tugraz/badge/?version=latest - :target: https://invenio-config-tugraz.readthedocs.io/en/latest/?badge=latest - -.. image:: https://img.shields.io/coveralls/mb-wali/invenio-config-tugraz.svg - :target: https://coveralls.io/r/mb-wali/invenio-config-tugraz +.. image:: https://readthedocs.org/projects/invenio-config-iform/badge/?version=latest + :target: https://invenio-config-iform.readthedocs.io/en/latest/?badge=latest + +.. image:: https://img.shields.io/coveralls/mb-wali/invenio-config-iform.svg + :target: https://coveralls.io/r/mb-wali/invenio-config-iform .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black -invenio module that adds tugraz configs. +invenio module that adds I-Form configs. Override configs from diffrent invenio modules to meet TU Graz requirement: @@ -42,4 +42,4 @@ Override configs from diffrent invenio modules to meet TU Graz requirement: * Defined routes for TUG Further documentation is available on -https://invenio-config-tugraz.readthedocs.io/ +https://invenio-config-iform.readthedocs.io/ diff --git a/babel.ini b/babel.ini index a87405a..7b8be97 100644 --- a/babel.ini +++ b/babel.ini @@ -2,7 +2,7 @@ # # Copyright (C) 2020 Mojib Wali. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. diff --git a/docs/Makefile b/docs/Makefile index b9a0e0c..b5d9897 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -87,9 +87,9 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/invenio-config-tugraz.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/invenio-config-iform.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/invenio-config-tugraz.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/invenio-config-iform.qhc" applehelp: $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp @@ -104,8 +104,8 @@ devhelp: @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/invenio-config-tugraz" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/invenio-config-tugraz" + @echo "# mkdir -p $$HOME/.local/share/devhelp/invenio-config-iform" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/invenio-config-iform" @echo "# devhelp" epub: diff --git a/docs/api.rst b/docs/api.rst index 13cd19b..5e5035d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,7 +1,7 @@ .. Copyright (C) 2020 Mojib Wali. - invenio-config-tugraz is free software; you can redistribute it and/or + invenio-config-iform is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details. @@ -9,5 +9,5 @@ API Docs ======== -.. automodule:: invenio_config_tugraz.ext +.. automodule:: invenio_config_iform.ext :members: diff --git a/docs/authors.rst b/docs/authors.rst index d975637..21ff917 100644 --- a/docs/authors.rst +++ b/docs/authors.rst @@ -1,7 +1,7 @@ .. Copyright (C) 2020 Mojib Wali. - invenio-config-tugraz is free software; you can redistribute it and/or + invenio-config-iform is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details. diff --git a/docs/changes.rst b/docs/changes.rst index 5a357f9..e90d97e 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -1,7 +1,7 @@ .. Copyright (C) 2020 Mojib Wali. - invenio-config-tugraz is free software; you can redistribute it and/or + invenio-config-iform is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details. diff --git a/docs/conf.py b/docs/conf.py index fa26a42..1ba2c8e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,13 +2,13 @@ # # Copyright (C) 2020 Mojib Wali. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. """Sphinx configuration.""" -from invenio_config_tugraz import __version__ +from invenio_config_iform import __version__ # import sphinx.environment @@ -46,7 +46,7 @@ source_suffix = ".rst" master_doc = "index" # General information about the project. -project = "invenio-config-tugraz" +project = "invenio-config-iform" copyright = "2022, TU Graz" author = "TU Graz" @@ -108,15 +108,15 @@ todo_include_todos = False html_theme = "alabaster" html_theme_options = { - "description": "invenio module that adds tugraz configs.", + "description": "invenio module that adds iform configs.", "github_user": "TU Graz", - "github_repo": "invenio-config-tugraz", + "github_repo": "invenio-config-iform", "github_button": False, "github_banner": True, "show_powered_by": False, "extra_nav_links": { - "invenio-config-tugraz@GitHub": "https://github.com/tu-graz-library/invenio-config-tugraz", - "invenio-config-tugraz@PyPI": "https://pypi.python.org/pypi/invenio-config-tugraz/", + "invenio-config-iform@Github": "https://github.com/Cian-H/invenio-config-iform", + "invenio-config-iform@PyPI": "https://pypi.python.org/pypi/invenio-config-iform/", }, } @@ -221,7 +221,7 @@ html_sidebars = { # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = "invenio-config-tugraz_namedoc" +htmlhelp_basename = "invenio-config-iform_namedoc" # -- Options for LaTeX output --------------------------------------------- @@ -242,8 +242,8 @@ latex_elements = { latex_documents = [ ( master_doc, - "invenio-config-tugraz.tex", - "invenio-config-tugraz Documentation", + "invenio-config-iform.tex", + "invenio-config-iform Documentation", "Mojib Wali", "manual", ), @@ -277,8 +277,8 @@ latex_documents = [ man_pages = [ ( master_doc, - "invenio-config-tugraz", - "invenio-config-tugraz Documentation", + "invenio-config-iform", + "invenio-config-iform Documentation", [author], 1, ) @@ -296,11 +296,11 @@ man_pages = [ texinfo_documents = [ ( master_doc, - "invenio-config-tugraz", - "invenio-config-tugraz Documentation", + "invenio-config-iform", + "invenio-config-iform Documentation", author, - "invenio-config-tugraz", - "invenio module that adds tugraz configs.", + "invenio-config-iform", + "invenio module that adds iform configs.", "Miscellaneous", ), ] diff --git a/docs/configuration.rst b/docs/configuration.rst index 59c71b8..4a0d128 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -1,7 +1,7 @@ .. Copyright (C) 2020 Mojib Wali. - invenio-config-tugraz is free software; you can redistribute it and/or + invenio-config-iform is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details. @@ -9,5 +9,5 @@ Configuration ============= -.. automodule:: invenio_config_tugraz.config +.. automodule:: invenio_config_iform.config :members: diff --git a/docs/contributing.rst b/docs/contributing.rst index 2a04184..e367a44 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,7 +1,7 @@ .. Copyright (C) 2020 Mojib Wali. - invenio-config-tugraz is free software; you can redistribute it and/or + invenio-config-iform is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details. diff --git a/docs/index.rst b/docs/index.rst index 4ed0a74..4a5e65c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ .. Copyright (C) 2020 Mojib Wali. - invenio-config-tugraz is free software; you can redistribute it and/or + invenio-config-iform is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details. @@ -12,7 +12,7 @@ User's Guide ------------ This part of the documentation will show you how to get started in using -invenio-config-tugraz. +invenio-config-iform. .. toctree:: :maxdepth: 2 diff --git a/docs/installation.rst b/docs/installation.rst index 0400495..91a2a59 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,7 +1,7 @@ .. Copyright (C) 2020 Mojib Wali. - invenio-config-tugraz is free software; you can redistribute it and/or + invenio-config-iform is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details. diff --git a/docs/make.bat b/docs/make.bat index 3f2cbb3..3692cf0 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -127,9 +127,9 @@ if "%1" == "qthelp" ( echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\invenio-config-tugraz.qhcp + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\invenio-config-iform.qhcp echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\invenio-config-tugraz.ghc + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\invenio-config-iform.ghc goto end ) diff --git a/docs/usage.rst b/docs/usage.rst index e0f67e3..bb07f2a 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -1,7 +1,7 @@ .. Copyright (C) 2020 Mojib Wali. - invenio-config-tugraz is free software; you can redistribute it and/or + invenio-config-iform is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details. @@ -9,4 +9,4 @@ Usage ===== -.. automodule:: invenio_config_tugraz +.. automodule:: invenio_config_iform diff --git a/invenio_config_tugraz/__init__.py b/invenio_config_iform/__init__.py similarity index 63% rename from invenio_config_tugraz/__init__.py rename to invenio_config_iform/__init__.py index 7e68d31..1121bea 100644 --- a/invenio_config_tugraz/__init__.py +++ b/invenio_config_iform/__init__.py @@ -2,19 +2,19 @@ # # Copyright (C) 2020-2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform 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 module that adds tugraz configs.""" +"""invenio module that adds I-Form configs.""" -from .ext import InvenioConfigTugraz +from .ext import InvenioConfigIform from .utils import get_identity_from_user_by_email __version__ = "0.12.5" __all__ = ( + "InvenioConfigIform", "__version__", - "InvenioConfigTugraz", "get_identity_from_user_by_email", ) diff --git a/invenio_config_tugraz/config.py b/invenio_config_iform/config.py similarity index 95% rename from invenio_config_tugraz/config.py rename to invenio_config_iform/config.py index dd0ddda..d8011df 100644 --- a/invenio_config_tugraz/config.py +++ b/invenio_config_iform/config.py @@ -2,36 +2,36 @@ # # Copyright (C) 2020-2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform 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 module that adds tugraz configs.""" +"""invenio module that adds I-Form configs.""" from invenio_i18n import gettext as _ -CONFIG_TUGRAZ_SHIBBOLETH = False +CONFIG_IFORM_SHIBBOLETH = False """Set True if SAML is configured""" -CONFIG_TUGRAZ_SINGLE_IPS = [] +CONFIG_IFORM_SINGLE_IPS = [] """Allows access to users whose IP address is listed. -INVENIO_CONFIG_TUGRAZ_SINGLE_IPS = +INVENIO_CONFIG_IFORM_SINGLE_IPS = ["127.0.0.1", "127.0.0.2"] """ -CONFIG_TUGRAZ_IP_RANGES = [] +CONFIG_IFORM_IP_RANGES = [] """Allows access to users whose range of IP address is listed. -INVENIO_CONFIG_TUGRAZ_IP_RANGES = +INVENIO_CONFIG_IFORM_IP_RANGES = [["127.0.0.2", "127.0.0.99"], ["127.0.1.3", "127.0.1.5"]] """ -CONFIG_TUGRAZ_IP_NETWORK = "" +CONFIG_IFORM_IP_NETWORK = "" """Allows access to users who are in the IP network.""" -CONFIG_TUGRAZ_ROUTES = { +CONFIG_IFORM_ROUTES = { "guide": "/guide", "terms": "/terms", "gdpr": "/gdpr", @@ -201,7 +201,7 @@ If False, you won't be able to login via the web UI. Instead if you have a overriden template somewhere in your config.py: like this: -SECURITY_LOGIN_USER_TEMPLATE = 'invenio_theme_tugraz/accounts/login.html' +SECURITY_LOGIN_USER_TEMPLATE = 'invenio_theme_iform/accounts/login.html' then you can remove this condition from header_login.htm: {%- if config.ACCOUNTS %} to render your overriden login.html @@ -220,8 +220,8 @@ RECAPTCHA_PRIVATE_KEY = None # See: # https://invenio-records-permissions.readthedocs.io/en/latest/configuration.html # Uncomment these to enable overriding RDM permissions -# from .rdm_permissions import TUGRAZRDMRecordServiceConfig -# RDM_RECORDS_BIBLIOGRAPHIC_SERVICE_CONFIG = TUGRAZRDMRecordServiceConfig +# from .rdm_permissions import IformRDMRecordServiceConfig +# RDM_RECORDS_BIBLIOGRAPHIC_SERVICE_CONFIG = IformRDMRecordServiceConfig """Access control configuration for records.""" # invenio-rdm-records diff --git a/invenio_config_tugraz/custom_fields/__init__.py b/invenio_config_iform/custom_fields/__init__.py similarity index 82% rename from invenio_config_tugraz/custom_fields/__init__.py rename to invenio_config_iform/custom_fields/__init__.py index 8995348..14f0139 100644 --- a/invenio_config_tugraz/custom_fields/__init__.py +++ b/invenio_config_iform/custom_fields/__init__.py @@ -2,7 +2,7 @@ # # Copyright (C) 2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. diff --git a/invenio_config_tugraz/ext.py b/invenio_config_iform/ext.py similarity index 81% rename from invenio_config_tugraz/ext.py rename to invenio_config_iform/ext.py index 6c47cf6..af46077 100644 --- a/invenio_config_tugraz/ext.py +++ b/invenio_config_iform/ext.py @@ -2,11 +2,11 @@ # # Copyright (C) 2020-2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform 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 module that adds tugraz configs.""" +"""invenio module that adds I-Form configs.""" from flask import Flask @@ -14,8 +14,8 @@ from . import config from .custom_fields import ip_network, single_ip -class InvenioConfigTugraz: - """invenio-config-tugraz extension.""" +class InvenioConfigIform: + """invenio-config-iform extension.""" def __init__(self, app: Flask = None) -> None: """Extension initialization.""" @@ -26,12 +26,12 @@ class InvenioConfigTugraz: """Flask application initialization.""" self.init_config(app) self.add_custom_fields(app) - app.extensions["invenio-config-tugraz"] = self + app.extensions["invenio-config-iform"] = self def init_config(self, app: Flask) -> None: """Initialize configuration.""" for k in dir(config): - if k.startswith("INVENIO_CONFIG_TUGRAZ_"): + if k.startswith("INVENIO_CONFIG_IFORM_"): app.config.setdefault(k, getattr(config, k)) def add_custom_fields(self, app: Flask) -> None: @@ -57,5 +57,5 @@ def rank_blueprint_higher(app: Flask) -> None: """ bps = app.blueprints for blueprint_name in list(bps.keys()): - if blueprint_name != "invenio_config_tugraz": + if blueprint_name != "invenio_config_iform": bps.update({blueprint_name: bps.pop(blueprint_name)}) diff --git a/invenio_config_tugraz/permissions/__init__.py b/invenio_config_iform/permissions/__init__.py similarity index 57% rename from invenio_config_tugraz/permissions/__init__.py rename to invenio_config_iform/permissions/__init__.py index 9bfa424..fa688c2 100644 --- a/invenio_config_tugraz/permissions/__init__.py +++ b/invenio_config_iform/permissions/__init__.py @@ -2,12 +2,12 @@ # # Copyright (C) 2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. """Permission-policies and roles, based on `flask-principal`.""" -from .policies import TUGrazRDMRecordPermissionPolicy +from .policies import IformRDMRecordPermissionPolicy -__all__ = ("TUGrazRDMRecordPermissionPolicy",) +__all__ = ("IformRDMRecordPermissionPolicy",) diff --git a/invenio_config_tugraz/permissions/generators.py b/invenio_config_iform/permissions/generators.py similarity index 94% rename from invenio_config_tugraz/permissions/generators.py rename to invenio_config_iform/permissions/generators.py index 669a1b5..15df714 100644 --- a/invenio_config_tugraz/permissions/generators.py +++ b/invenio_config_iform/permissions/generators.py @@ -2,7 +2,7 @@ # # Copyright (C) 2020-2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. @@ -54,7 +54,7 @@ from invenio_access.permissions import any_user from invenio_records_permissions.generators import Generator from invenio_search.engine import dsl -from .roles import tugraz_authenticated_user +from .roles import iform_authenticated_user class RecordSingleIP(Generator): @@ -124,7 +124,7 @@ class RecordSingleIP(Generator): except RuntimeError: return False - single_ips = current_app.config["CONFIG_TUGRAZ_SINGLE_IPS"] + single_ips = current_app.config["CONFIG_IFORM_SINGLE_IPS"] return user_ip in single_ips @@ -191,7 +191,7 @@ class AllowedFromIPNetwork(Generator): except RuntimeError: return False - network = current_app.config["CONFIG_TUGRAZ_IP_NETWORK"] + network = current_app.config["CONFIG_IFORM_IP_NETWORK"] try: return ip_address(user_ip) in ip_network(network) @@ -199,9 +199,9 @@ class AllowedFromIPNetwork(Generator): return False -class TUGrazAuthenticatedUser(Generator): - """Generates the `tugraz_authenticated_user` role-need.""" +class IformAuthenticatedUser(Generator): + """Generates the `iform_authenticated_user` role-need.""" def needs(self, **__: dict) -> list[Need]: """Generate needs to be checked against current user identity.""" - return [tugraz_authenticated_user] + return [iform_authenticated_user] diff --git a/invenio_config_tugraz/permissions/policies.py b/invenio_config_iform/permissions/policies.py similarity index 89% rename from invenio_config_tugraz/permissions/policies.py rename to invenio_config_iform/permissions/policies.py index a2e27cb..dbd6498 100644 --- a/invenio_config_tugraz/permissions/policies.py +++ b/invenio_config_iform/permissions/policies.py @@ -2,13 +2,13 @@ # # Copyright (C) 2020-2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. """TU Graz permission-policy for RDMRecordService. -To use, set config-variable `RDM_PERMISSION_POLICY` to `TUGrazRDMRecordPermissionPolicy`. +To use, set config-variable `RDM_PERMISSION_POLICY` to `IformRDMRecordPermissionPolicy`. Policies list **what actions** can be done **by whom** over an implied category of objects (typically records). A Policy is @@ -52,11 +52,11 @@ from invenio_records_permissions.generators import ( from invenio_records_permissions.policies.records import RecordPermissionPolicy from invenio_users_resources.services.permissions import UserManager -from .generators import AllowedFromIPNetwork, RecordSingleIP, TUGrazAuthenticatedUser +from .generators import AllowedFromIPNetwork, IformAuthenticatedUser, RecordSingleIP -class TUGrazRDMRecordPermissionPolicy(RecordPermissionPolicy): - """Overwrite authenticatedness to mean `tugraz_authenticated` rather than *signed up*.""" +class IformRDMRecordPermissionPolicy(RecordPermissionPolicy): + """Overwrite authenticatedness to mean `iform_authenticated` rather than *signed up*.""" NEED_LABEL_TO_ACTION = { "bucket-update": "update_files", @@ -91,8 +91,8 @@ class TUGrazRDMRecordPermissionPolicy(RecordPermissionPolicy): RecordSingleIP(), ] - can_tugraz_authenticated = [TUGrazAuthenticatedUser(), SystemProcess()] - can_authenticated = can_tugraz_authenticated + can_iform_authenticated = [IformAuthenticatedUser(), SystemProcess()] + can_authenticated = can_iform_authenticated can_all = [ AnyUser(), SystemProcess(), @@ -126,12 +126,12 @@ class TUGrazRDMRecordPermissionPolicy(RecordPermissionPolicy): can_get_content_files = [ IfFileIsLocal(then_=can_read_files, else_=[SystemProcess()]), ] - can_create = can_tugraz_authenticated + can_create = can_iform_authenticated # # Drafts # - can_search_drafts = can_tugraz_authenticated + can_search_drafts = can_iform_authenticated can_read_draft = can_preview can_draft_read_files = can_preview + [ResourceAccessToken("read")] can_update_draft = can_review @@ -148,14 +148,14 @@ class TUGrazRDMRecordPermissionPolicy(RecordPermissionPolicy): can_manage_files = [ IfConfig( "RDM_ALLOW_METADATA_ONLY_RECORDS", - then_=[IfNewRecord(then_=can_tugraz_authenticated, else_=can_review)], + then_=[IfNewRecord(then_=can_iform_authenticated, else_=can_review)], else_=[], ), ] can_manage_record_access = [ IfConfig( "RDM_ALLOW_RESTRICTED_RECORDS", - then_=[IfNewRecord(then_=can_tugraz_authenticated, else_=can_review)], + then_=[IfNewRecord(then_=can_iform_authenticated, else_=can_review)], else_=[], ), ] diff --git a/invenio_config_tugraz/permissions/roles.py b/invenio_config_iform/permissions/roles.py similarity index 65% rename from invenio_config_tugraz/permissions/roles.py rename to invenio_config_iform/permissions/roles.py index 6739ff4..a9c008c 100644 --- a/invenio_config_tugraz/permissions/roles.py +++ b/invenio_config_iform/permissions/roles.py @@ -2,20 +2,20 @@ # # Copyright (C) 2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. """`RoleNeed`s for permission policies. To use these roles, add them to the database via: - `$ invenio roles create tugraz_authenticated --description "..."` + `$ invenio roles create iform_authenticated --description "..."` then add roles to users via: - `$ invenio roles add user@email.com tugraz_authenticated` + `$ invenio roles add user@email.com iform_authenticated` """ from flask_principal import RoleNeed # using `flask_principal.RoleNeed`` instead of `invenio_access.SystemRoleNeed`, # because these roles are assigned by an admin rather than automatically by the system -tugraz_authenticated_user = RoleNeed("tugraz_authenticated") +iform_authenticated_user = RoleNeed("iform_authenticated") diff --git a/invenio_config_tugraz/restrictions/access_right/access_right.csv b/invenio_config_iform/restrictions/access_right/access_right.csv similarity index 100% rename from invenio_config_tugraz/restrictions/access_right/access_right.csv rename to invenio_config_iform/restrictions/access_right/access_right.csv diff --git a/invenio_config_tugraz/restrictions/access_right/access_right_limit.csv b/invenio_config_iform/restrictions/access_right/access_right_limit.csv similarity index 100% rename from invenio_config_tugraz/restrictions/access_right/access_right_limit.csv rename to invenio_config_iform/restrictions/access_right/access_right_limit.csv diff --git a/invenio_config_tugraz/static/documents/TUGraz_Repository_General_Data_Protection_Rights_de.pdf b/invenio_config_iform/static/documents/TUGraz_Repository_General_Data_Protection_Rights_de.pdf similarity index 100% rename from invenio_config_tugraz/static/documents/TUGraz_Repository_General_Data_Protection_Rights_de.pdf rename to invenio_config_iform/static/documents/TUGraz_Repository_General_Data_Protection_Rights_de.pdf diff --git a/invenio_config_tugraz/static/documents/TUGraz_Repository_General_Data_Protection_Rights_en.pdf b/invenio_config_iform/static/documents/TUGraz_Repository_General_Data_Protection_Rights_en.pdf similarity index 100% rename from invenio_config_tugraz/static/documents/TUGraz_Repository_General_Data_Protection_Rights_en.pdf rename to invenio_config_iform/static/documents/TUGraz_Repository_General_Data_Protection_Rights_en.pdf diff --git a/invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_01_de.pdf b/invenio_config_iform/static/documents/TUGraz_Repository_Guide_01_de.pdf similarity index 100% rename from invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_01_de.pdf rename to invenio_config_iform/static/documents/TUGraz_Repository_Guide_01_de.pdf diff --git a/invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_01_en.pdf b/invenio_config_iform/static/documents/TUGraz_Repository_Guide_01_en.pdf similarity index 100% rename from invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_01_en.pdf rename to invenio_config_iform/static/documents/TUGraz_Repository_Guide_01_en.pdf diff --git a/invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_02.1_de.pdf b/invenio_config_iform/static/documents/TUGraz_Repository_Guide_02.1_de.pdf similarity index 100% rename from invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_02.1_de.pdf rename to invenio_config_iform/static/documents/TUGraz_Repository_Guide_02.1_de.pdf diff --git a/invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_02.1_en.pdf b/invenio_config_iform/static/documents/TUGraz_Repository_Guide_02.1_en.pdf similarity index 100% rename from invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_02.1_en.pdf rename to invenio_config_iform/static/documents/TUGraz_Repository_Guide_02.1_en.pdf diff --git a/invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_02_de.pdf b/invenio_config_iform/static/documents/TUGraz_Repository_Guide_02_de.pdf similarity index 100% rename from invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_02_de.pdf rename to invenio_config_iform/static/documents/TUGraz_Repository_Guide_02_de.pdf diff --git a/invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_02_en.pdf b/invenio_config_iform/static/documents/TUGraz_Repository_Guide_02_en.pdf similarity index 100% rename from invenio_config_tugraz/static/documents/TUGraz_Repository_Guide_02_en.pdf rename to invenio_config_iform/static/documents/TUGraz_Repository_Guide_02_en.pdf diff --git a/invenio_config_tugraz/static/documents/TUGraz_Repository_Terms_And_Conditions_de.pdf b/invenio_config_iform/static/documents/TUGraz_Repository_Terms_And_Conditions_de.pdf similarity index 100% rename from invenio_config_tugraz/static/documents/TUGraz_Repository_Terms_And_Conditions_de.pdf rename to invenio_config_iform/static/documents/TUGraz_Repository_Terms_And_Conditions_de.pdf diff --git a/invenio_config_tugraz/static/documents/TUGraz_Repository_Terms_And_Conditions_en.pdf b/invenio_config_iform/static/documents/TUGraz_Repository_Terms_And_Conditions_en.pdf similarity index 100% rename from invenio_config_tugraz/static/documents/TUGraz_Repository_Terms_And_Conditions_en.pdf rename to invenio_config_iform/static/documents/TUGraz_Repository_Terms_And_Conditions_en.pdf diff --git a/invenio_config_tugraz/templates/security/email/welcome.txt b/invenio_config_iform/templates/security/email/welcome.txt similarity index 86% rename from invenio_config_tugraz/templates/security/email/welcome.txt rename to invenio_config_iform/templates/security/email/welcome.txt index f226546..86a83a4 100644 --- a/invenio_config_tugraz/templates/security/email/welcome.txt +++ b/invenio_config_iform/templates/security/email/welcome.txt @@ -4,10 +4,10 @@ {{ _('To help you get started, here are some useful links:') }} - - {{ _('Guidelines:')}} {{ _('Repository Guide')}} ({{ _('how to upload files')}}) ({{ config.SITE_UI_URL }}{{ url_for('invenio_config_tugraz.guide') }}) + - {{ _('Guidelines:')}} {{ _('Repository Guide')}} ({{ _('how to upload files')}}) ({{ config.SITE_UI_URL }}{{ url_for('invenio_config_iform.guide') }}) - {{ _('Search Guide')}} ({{ config.SITE_UI_URL }}{{url_for('invenio_app_rdm.help_search')}}) - - {{ _('Terms And Conditions') }} ({{ config.SITE_UI_URL }}{{ url_for('invenio_config_tugraz.terms') }}) - - {{ _('Data Protection Rights')}} ({{ config.SITE_UI_URL }}{{ url_for('invenio_config_tugraz.gdpr') }}) + - {{ _('Terms And Conditions') }} ({{ config.SITE_UI_URL }}{{ url_for('invenio_config_iform.terms') }}) + - {{ _('Data Protection Rights')}} ({{ config.SITE_UI_URL }}{{ url_for('invenio_config_iform.gdpr') }}) {% if security.confirmable %} {{ _('You can confirm your email through the link below:') }} {{ confirmation_link }}"> diff --git a/invenio_config_tugraz/translations/.gitkeep b/invenio_config_iform/translations/.gitkeep similarity index 100% rename from invenio_config_tugraz/translations/.gitkeep rename to invenio_config_iform/translations/.gitkeep diff --git a/invenio_config_tugraz/translations/de/LC_MESSAGES/messages.po b/invenio_config_iform/translations/de/LC_MESSAGES/messages.po similarity index 63% rename from invenio_config_tugraz/translations/de/LC_MESSAGES/messages.po rename to invenio_config_iform/translations/de/LC_MESSAGES/messages.po index cda3e26..f9ea542 100644 --- a/invenio_config_tugraz/translations/de/LC_MESSAGES/messages.po +++ b/invenio_config_iform/translations/de/LC_MESSAGES/messages.po @@ -1,12 +1,12 @@ -# German translations for invenio-config-tugraz. +# German translations for invenio-config-iform. # Copyright (C) 2021 Graz University of Technology # This file is distributed under the same license as the -# invenio-config-tugraz project. +# invenio-config-iform project. # FIRST AUTHOR , 2021. # msgid "" msgstr "" -"Project-Id-Version: invenio-config-tugraz 0.5.5\n" +"Project-Id-Version: invenio-config-iform 0.5.5\n" "Report-Msgid-Bugs-To: mojib.wali@tugraz.at\n" "POT-Creation-Date: 2021-04-27 15:30+0200\n" "PO-Revision-Date: 2021-04-22 11:57+0200\n" @@ -19,53 +19,53 @@ msgstr "" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.9.0\n" -#: invenio_config_tugraz/config.py:87 +#: invenio_config_iform/config.py:87 msgid "Welcome to TU Graz Repository!" msgstr "Willkommen im TU Graz Repository!" -#: invenio_config_tugraz/templates/security/email/welcome.txt:1 +#: invenio_config_iform/templates/security/email/welcome.txt:1 msgid "Dear user," msgstr "Lieber Nutzer," -#: invenio_config_tugraz/templates/security/email/welcome.txt:3 +#: invenio_config_iform/templates/security/email/welcome.txt:3 msgid "Welcome to the Repository of TU Graz!" msgstr "Willkommen im TU Graz Repository!" -#: invenio_config_tugraz/templates/security/email/welcome.txt:5 +#: invenio_config_iform/templates/security/email/welcome.txt:5 msgid "To help you get started, here are some useful links:" msgstr "" "Um Ihnen den Einstieg zu erleichtern, finden Sie hier einige nützliche " "Links:" -#: invenio_config_tugraz/templates/security/email/welcome.txt:7 +#: invenio_config_iform/templates/security/email/welcome.txt:7 msgid "Guidelines:" msgstr "Leitfaden:" -#: invenio_config_tugraz/templates/security/email/welcome.txt:7 +#: invenio_config_iform/templates/security/email/welcome.txt:7 msgid "Repository Guide" msgstr "Handbuch" -#: invenio_config_tugraz/templates/security/email/welcome.txt:7 +#: invenio_config_iform/templates/security/email/welcome.txt:7 msgid "how to upload files" msgstr "wie man Dateien hochlädt" -#: invenio_config_tugraz/templates/security/email/welcome.txt:8 +#: invenio_config_iform/templates/security/email/welcome.txt:8 msgid "Search Guide" msgstr "Suchanleitung" -#: invenio_config_tugraz/templates/security/email/welcome.txt:9 +#: invenio_config_iform/templates/security/email/welcome.txt:9 msgid "Terms And Conditions" msgstr "Nutzungsbedingungen" -#: invenio_config_tugraz/templates/security/email/welcome.txt:10 +#: invenio_config_iform/templates/security/email/welcome.txt:10 msgid "Data Protection Rights" msgstr "Datenschutzerklärung" -#: invenio_config_tugraz/templates/security/email/welcome.txt:13 +#: invenio_config_iform/templates/security/email/welcome.txt:13 msgid "You can confirm your email through the link below:" msgstr "Sie können Ihre E-Mail über den folgenden Link bestätigen:" -#: invenio_config_tugraz/templates/security/email/welcome.txt:16 +#: invenio_config_iform/templates/security/email/welcome.txt:16 msgid "" "If you require any assistance please do not hesitate to contact us at " "repository-support@tugraz.at." @@ -73,11 +73,10 @@ msgstr "" "Wenn Sie Hilfe benötigen, zögern Sie bitte nicht, uns unter repository-" "support@tugraz.at zu kontaktieren." -#: invenio_config_tugraz/templates/security/email/welcome.txt:18 +#: invenio_config_iform/templates/security/email/welcome.txt:18 msgid "Best regards," msgstr "Mit freundlichen Grüßen," -#: invenio_config_tugraz/templates/security/email/welcome.txt:19 +#: invenio_config_iform/templates/security/email/welcome.txt:19 msgid "TU Graz Repository Team" msgstr "TU Graz Repository Team" - diff --git a/invenio_config_tugraz/translations/messages.pot b/invenio_config_iform/translations/messages.pot similarity index 54% rename from invenio_config_tugraz/translations/messages.pot rename to invenio_config_iform/translations/messages.pot index 5c1b674..b066654 100644 --- a/invenio_config_tugraz/translations/messages.pot +++ b/invenio_config_iform/translations/messages.pot @@ -1,13 +1,13 @@ -# Translations template for invenio-config-tugraz. +# Translations template for invenio-config-iform. # Copyright (C) 2021 Graz University of Technology # This file is distributed under the same license as the -# invenio-config-tugraz project. +# invenio-config-iform project. # FIRST AUTHOR , 2021. # #, fuzzy msgid "" msgstr "" -"Project-Id-Version: invenio-config-tugraz 0.5.5\n" +"Project-Id-Version: invenio-config-iform 0.5.5\n" "Report-Msgid-Bugs-To: mojib.wali@tugraz.at\n" "POT-Creation-Date: 2021-04-27 15:30+0200\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" @@ -18,61 +18,60 @@ msgstr "" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.9.0\n" -#: invenio_config_tugraz/config.py:87 +#: invenio_config_iform/config.py:87 msgid "Welcome to TU Graz Repository!" msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:1 +#: invenio_config_iform/templates/security/email/welcome.txt:1 msgid "Dear user," msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:3 +#: invenio_config_iform/templates/security/email/welcome.txt:3 msgid "Welcome to the Repository of TU Graz!" msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:5 +#: invenio_config_iform/templates/security/email/welcome.txt:5 msgid "To help you get started, here are some useful links:" msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:7 +#: invenio_config_iform/templates/security/email/welcome.txt:7 msgid "Guidelines:" msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:7 +#: invenio_config_iform/templates/security/email/welcome.txt:7 msgid "Repository Guide" msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:7 +#: invenio_config_iform/templates/security/email/welcome.txt:7 msgid "how to upload files" msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:8 +#: invenio_config_iform/templates/security/email/welcome.txt:8 msgid "Search Guide" msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:9 +#: invenio_config_iform/templates/security/email/welcome.txt:9 msgid "Terms And Conditions" msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:10 +#: invenio_config_iform/templates/security/email/welcome.txt:10 msgid "Data Protection Rights" msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:13 +#: invenio_config_iform/templates/security/email/welcome.txt:13 msgid "You can confirm your email through the link below:" msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:16 +#: invenio_config_iform/templates/security/email/welcome.txt:16 msgid "" "If you require any assistance please do not hesitate to contact us at " "repository-support@tugraz.at." msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:18 +#: invenio_config_iform/templates/security/email/welcome.txt:18 msgid "Best regards," msgstr "" -#: invenio_config_tugraz/templates/security/email/welcome.txt:19 +#: invenio_config_iform/templates/security/email/welcome.txt:19 msgid "TU Graz Repository Team" msgstr "" - diff --git a/invenio_config_tugraz/utils.py b/invenio_config_iform/utils.py similarity index 68% rename from invenio_config_tugraz/utils.py rename to invenio_config_iform/utils.py index 74b414f..9d11f0a 100644 --- a/invenio_config_tugraz/utils.py +++ b/invenio_config_iform/utils.py @@ -2,7 +2,7 @@ # # Copyright (C) 2022-2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. @@ -38,8 +38,8 @@ def get_identity_from_user_by_email(email: str | None = None) -> Identity: return identity -def tugraz_account_setup_extension(user, account_info) -> None: # noqa: ANN001, ARG001 - """Add tugraz_authenticated role to user after SAML-login was acknowledged. +def iform_account_setup_extension(user, account_info) -> None: # noqa: ANN001, ARG001 + """Add iform_authenticated role to user after SAML-login was acknowledged. To use, have `acs_handler_factory` call invenio_saml's `default_account_setup` first, then this function second. @@ -49,25 +49,25 @@ def tugraz_account_setup_extension(user, account_info) -> None: # noqa: ANN001, # invenio.cfg from invenio_saml.handlers import default_account_setup, acs_handler_factory - def tugraz_account_setup(user, account_info): + def iform_account_setup(user, account_info): # links external `account_info` with our database's `user` for future logins default_account_setup(user, account_info) - tugraz_account_setup_extension(user, account_info) + iform_account_setup_extension(user, account_info) SSO_SAML_IDPS = { - "my-tugraz-idp": { + "my-iform-idp": { ... "acs_handler": acs_handler_factory( - "my-tugraz-idp", account_setup=tugraz_account_setup + "my-iform-idp", account_setup=iform_account_setup ) } } - For this to work, the role tugraz_authenticated must have been created - (e.g. via `invenio roles create tugraz_authenticated`). + For this to work, the role iform_authenticated must have been created + (e.g. via `invenio roles create iform_authenticated`). """ user_email = account_info["user"]["email"] # NOTE: `datastore.commit`ing will be done by acs_handler that calls this func - # NOTE: this is a No-Op when user_email already has role tugraz_authenticated - current_accounts.datastore.add_role_to_user(user_email, "tugraz_authenticated") + # NOTE: this is a No-Op when user_email already has role iform_authenticated + current_accounts.datastore.add_role_to_user(user_email, "iform_authenticated") diff --git a/invenio_config_tugraz/views.py b/invenio_config_iform/views.py similarity index 75% rename from invenio_config_tugraz/views.py rename to invenio_config_iform/views.py index bbcab19..e504bcc 100644 --- a/invenio_config_tugraz/views.py +++ b/invenio_config_iform/views.py @@ -2,11 +2,11 @@ # # Copyright (C) 2020-2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform 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 module for TUGRAZ config.""" +"""Invenio module for I-Form config.""" from flask import Blueprint, Flask, redirect, url_for from invenio_i18n import get_locale @@ -14,11 +14,11 @@ from werkzeug.wrappers import Response as BaseResponse def ui_blueprint(app: Flask) -> Blueprint: - """Blueprint for the routes and resources provided by invenio-config-tugraz.""" - routes = app.config.get("CONFIG_TUGRAZ_ROUTES") + """Blueprint for the routes and resources provided by invenio-config-iform.""" + routes = app.config.get("CONFIG_IFORM_ROUTES") blueprint = Blueprint( - "invenio_config_tugraz", + "invenio_config_iform", __name__, template_folder="templates", static_folder="static", @@ -32,12 +32,12 @@ def ui_blueprint(app: Flask) -> Blueprint: def guide() -> BaseResponse: - """TUGraz_Repository_Guide.""" + """I-Form_Repository_Guide.""" locale = get_locale() return redirect( url_for( "static", - filename=f"documents/TUGraz_Repository_Guide_02.1_{locale}.pdf", + filename=f"documents/I-Form_Repository_Guide_02.1_{locale}.pdf", _external=True, ), ) @@ -49,7 +49,7 @@ def terms() -> BaseResponse: return redirect( url_for( "static", - filename=f"documents/TUGraz_Repository_Terms_And_Conditions_{locale}.pdf", + filename=f"documents/I-Form_Repository_Terms_And_Conditions_{locale}.pdf", _external=True, ), ) @@ -61,7 +61,7 @@ def gdpr() -> BaseResponse: return redirect( url_for( "static", - filename=f"documents/TUGraz_Repository_General_Data_Protection_Rights_{locale}.pdf", + filename=f"documents/I-Form_Repository_General_Data_Protection_Rights_{locale}.pdf", _external=True, ), ) diff --git a/run-tests.sh b/run-tests.sh index d7688bc..a0ffb13 100755 --- a/run-tests.sh +++ b/run-tests.sh @@ -5,7 +5,7 @@ # Copyright (C) 2019-2020 Northwestern University. # Copyright (C) 2020-2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. diff --git a/setup.cfg b/setup.cfg index 989a258..c1822b4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -2,21 +2,21 @@ # # Copyright (C) 2020-2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. [metadata] -name = invenio-config-tugraz -version = attr: invenio_config_tugraz.__version__ -description = "Invenio module that adds tugraz configs." +name = invenio-config-iform +version = attr: invenio_config_iform.__version__ +description = "Invenio module that adds I-Form configs." long_description = file: README.rst, CHANGES.rst keywords = invenio config TU-Graz license = MIT author = "Graz University of Technology" author_email = info@tugraz.at platforms = any -url = https://github.com/tu-graz-library/invenio-config-tugraz +url = https://github.com/Cian-H/invenio_config_iform classifiers = Environment :: Web Environment Intended Audience :: Developers @@ -49,15 +49,15 @@ tests = [options.entry_points] invenio_base.apps = - invenio_config_tugraz = invenio_config_tugraz:InvenioConfigTugraz + invenio_config_iform = invenio_config_iform:InvenioConfigIform invenio_base.blueprints = - invenio_config_tugraz = invenio_config_tugraz.views:ui_blueprint + invenio_config_iform = invenio_config_iform.views:ui_blueprint invenio_i18n.translations = - messages = invenio_config_tugraz + messages = invenio_config_iform invenio_config.module = - invenio_config_tugraz = invenio_config_tugraz.config + invenio_config_iform = invenio_config_iform.config invenio_base.finalize_app = - invenio_config_tugraz = invenio_config_tugraz.ext:finalize_app + invenio_config_iform = invenio_config_iform.ext:finalize_app [aliases] test = pytest @@ -71,22 +71,22 @@ all_files = 1 universal = 1 [compile_catalog] -directory = invenio_config_tugraz/translations/ +directory = invenio_config_iform/translations/ [extract_messages] copyright_holder = Graz University of Technology msgid_bugs_address = mojib.wali@tugraz.at mapping-file = babel.ini -output-file = invenio_config_tugraz/translations/messages.pot +output-file = invenio_config_iform/translations/messages.pot add-comments = NOTE [init_catalog] -input-file = invenio_config_tugraz/translations/messages.pot -output-dir = invenio_config_tugraz/translations/ +input-file = invenio_config_iform/translations/messages.pot +output-dir = invenio_config_iform/translations/ [update_catalog] -input-file = invenio_config_tugraz/translations/messages.pot -output-dir = invenio_config_tugraz/translations/ +input-file = invenio_config_iform/translations/messages.pot +output-dir = invenio_config_iform/translations/ [isort] profile=black @@ -95,6 +95,6 @@ profile=black ignore = *-requirements.txt [tool:pytest] -addopts = --black --cov=invenio_config_tugraz --cov-report=term-missing -testpaths = tests invenio_config_tugraz +addopts = --black --cov=invenio_config_iform --cov-report=term-missing +testpaths = tests invenio_config_iform live_server_scope = module diff --git a/setup.py b/setup.py index 353223b..4bd6599 100644 --- a/setup.py +++ b/setup.py @@ -2,11 +2,11 @@ # # Copyright (C) 2020-2022 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform 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 module that adds tugraz configs.""" +"""invenio module that adds I-Form configs.""" from setuptools import setup diff --git a/tests/conftest.py b/tests/conftest.py index a357b7c..39ce8a6 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -3,7 +3,7 @@ # Copyright (C) 2020 Mojib Wali. # Copyright (C) 2020-2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. @@ -17,7 +17,7 @@ fixtures are available. import pytest from flask import Flask -from invenio_config_tugraz import InvenioConfigTugraz +from invenio_config_iform import InvenioConfigIform @pytest.fixture(scope="module") @@ -27,7 +27,7 @@ def create_app(instance_path: str) -> Flask: def factory(**config: str) -> Flask: app = Flask("testapp", instance_path=instance_path) app.config.update(**config) - InvenioConfigTugraz(app) + InvenioConfigIform(app) return app return factory diff --git a/tests/test_invenio_config_tugraz.py b/tests/test_invenio_config_tugraz.py index 2d027a9..90a5304 100644 --- a/tests/test_invenio_config_tugraz.py +++ b/tests/test_invenio_config_tugraz.py @@ -2,7 +2,7 @@ # # Copyright (C) 2020-2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. @@ -10,12 +10,12 @@ from flask import Flask -from invenio_config_tugraz import InvenioConfigTugraz +from invenio_config_iform import InvenioConfigIform def test_version() -> None: """Test version import.""" - from invenio_config_tugraz import __version__ + from invenio_config_iform import __version__ assert __version__ @@ -23,11 +23,11 @@ def test_version() -> None: def test_init() -> None: """Test extension initialization.""" app = Flask("testapp") - ext = InvenioConfigTugraz(app) - assert "invenio-config-tugraz" in app.extensions + ext = InvenioConfigIform(app) + assert "invenio-config-iform" in app.extensions app = Flask("testapp") - ext = InvenioConfigTugraz() - assert "invenio-config-tugraz" not in app.extensions + ext = InvenioConfigIform() + assert "invenio-config-iform" not in app.extensions ext.init_app(app) - assert "invenio-config-tugraz" in app.extensions + assert "invenio-config-iform" in app.extensions diff --git a/tests/test_policies.py b/tests/test_policies.py index 42a0355..4127b9f 100644 --- a/tests/test_policies.py +++ b/tests/test_policies.py @@ -2,7 +2,7 @@ # # Copyright (C) 2024 Graz University of Technology. # -# invenio-config-tugraz is free software; you can redistribute it and/or +# invenio-config-iform is free software; you can redistribute it and/or # modify it under the terms of the MIT License; see LICENSE file for more # details. @@ -10,7 +10,7 @@ from invenio_rdm_records.services.permissions import RDMRecordPermissionPolicy -from invenio_config_tugraz.permissions.policies import TUGrazRDMRecordPermissionPolicy +from invenio_config_iform.permissions.policies import IformRDMRecordPermissionPolicy ALLOWED_DIFFERENCES = { "can_authenticated", @@ -19,15 +19,15 @@ ALLOWED_DIFFERENCES = { "can_view", "can_all", "can_search_drafts", - "can_tugraz_authenticated", + "can_iform_authenticated", } def test_policies_synced() -> None: """Make sure our permission-policy stays synced with invenio's.""" - tugraz_cans = { - name: getattr(TUGrazRDMRecordPermissionPolicy, name) - for name in dir(TUGrazRDMRecordPermissionPolicy) + iform_cans = { + name: getattr(IformRDMRecordPermissionPolicy, name) + for name in dir(IformRDMRecordPermissionPolicy) if name.startswith("can_") } rdm_cans = { @@ -37,52 +37,52 @@ def test_policies_synced() -> None: } # check whether same set of `can_`s` - if extras := set(tugraz_cans) - set(rdm_cans) - ALLOWED_DIFFERENCES: + if extras := set(iform_cans) - set(rdm_cans) - ALLOWED_DIFFERENCES: msg = f""" TU Graz's permission-policy has additional fields over invenio-rdm's:{extras} if this is intentional, add to ALLOWED_DIFFERENCES in test-file - otherwise remove extraneous fields from TUGrazRDMRecordPermissionPolicy + otherwise remove extraneous fields from IformRDMRecordPermissionPolicy """ raise KeyError(msg) - if missing := set(rdm_cans) - set(tugraz_cans): + if missing := set(rdm_cans) - set(iform_cans): msg = f""" invenio-rdm's permission-policy has fields unhandled by TU Graz's: {missing} if this is intentional, add to ALLOWED_DIFFERENCES - otherwise set the corresponding fields in TUGrazRDMRecordPermissionPolicy + otherwise set the corresponding fields in IformRDMRecordPermissionPolicy """ raise KeyError(msg) # check whether same permission-generators used for same `can_` - for can_name in rdm_cans.keys() & tugraz_cans.keys(): + for can_name in rdm_cans.keys() & iform_cans.keys(): if can_name in ALLOWED_DIFFERENCES: continue - tugraz_can = tugraz_cans[can_name] + iform_can = iform_cans[can_name] rdm_can = rdm_cans[can_name] # permission-Generators don't implement equality checks for their instances # we can however compare which types (classes) of Generators are used... - if {type(gen) for gen in tugraz_can} != {type(gen) for gen in rdm_can}: + if {type(gen) for gen in iform_can} != {type(gen) for gen in rdm_can}: msg = f""" permission-policy for `{can_name}` differs between TU-Graz and invenio-rdm if this is intentional, add to ALLOWED_DIFFERENCES in test-file - otherwise fix TUGrazRDMRecordPermissionPolicy + otherwise fix IformRDMRecordPermissionPolicy """ raise ValueError(msg) # check whether same `NEED_LABEL_TO_ACTION` - tugraz_label_to_action = TUGrazRDMRecordPermissionPolicy.NEED_LABEL_TO_ACTION + iform_label_to_action = IformRDMRecordPermissionPolicy.NEED_LABEL_TO_ACTION rdm_label_to_action = RDMRecordPermissionPolicy.NEED_LABEL_TO_ACTION - for label in tugraz_label_to_action.keys() & rdm_label_to_action.keys(): + for label in iform_label_to_action.keys() & rdm_label_to_action.keys(): if label in ALLOWED_DIFFERENCES: continue - if tugraz_label_to_action.get(label) != rdm_label_to_action.get(label): + if iform_label_to_action.get(label) != rdm_label_to_action.get(label): msg = f""" invenio-rdm's NEED_LABEL_TO_ACTION differs from TU Graz's in {label} if this is intentional, add to ALLOWED_DIFFERENCES in test-file - otherwise fix TUGrazRDMRecordPermissionPolicy.NEED_LABEL_TO_ACTION + otherwise fix IformRDMRecordPermissionPolicy.NEED_LABEL_TO_ACTION """ raise ValueError(msg)