From ceb0824a30f174770feb87cb0e9691ad8d6127e4 Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Fri, 7 Feb 2025 16:39:20 +0100 Subject: [PATCH 1/3] :arrow_up: [#43] Upgrade django-setup-configuration to 0.7.1 --- requirements/base.txt | 8 +++++++- requirements/ci.txt | 19 ++++++++++++++++--- requirements/dev.txt | 17 ++++++++++++++--- 3 files changed, 37 insertions(+), 7 deletions(-) diff --git a/requirements/base.txt b/requirements/base.txt index fbb4daa..9f4841f 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -154,7 +154,7 @@ django-sendfile2==0.7.1 # via django-privates django-sessionprofile==3.0.0 # via open-api-framework -django-setup-configuration==0.5.0 +django-setup-configuration==0.7.1 # via # mozilla-django-oidc-db # open-api-framework @@ -187,6 +187,8 @@ djangorestframework-gis==1.0 # via open-api-framework djangorestframework-inclusions==1.2.0 # via open-api-framework +docutils==0.21.2 + # via django-setup-configuration drf-nested-routers==0.94.1 # via commonground-api-common drf-spectacular==0.27.2 @@ -327,6 +329,10 @@ rpds-py==0.19.1 # via # jsonschema # referencing +ruamel-yaml==0.18.10 + # via django-setup-configuration +ruamel-yaml-clib==0.2.12 + # via ruamel-yaml sentry-sdk==2.13.0 # via open-api-framework six==1.16.0 diff --git a/requirements/ci.txt b/requirements/ci.txt index 8676347..9ee608e 100644 --- a/requirements/ci.txt +++ b/requirements/ci.txt @@ -292,7 +292,7 @@ django-sessionprofile==3.0.0 # -c requirements/base.txt # -r requirements/base.txt # open-api-framework -django-setup-configuration==0.5.0 +django-setup-configuration==0.7.1 # via # -c requirements/base.txt # -r requirements/base.txt @@ -346,8 +346,11 @@ djangorestframework-inclusions==1.2.0 # -c requirements/base.txt # -r requirements/base.txt # open-api-framework -docutils==0.20.1 +docutils==0.21.2 # via + # -c requirements/base.txt + # -r requirements/base.txt + # django-setup-configuration # sphinx # sphinx-rtd-theme drf-nested-routers==0.94.1 @@ -686,6 +689,16 @@ rpds-py==0.19.1 # -r requirements/base.txt # jsonschema # referencing +ruamel-yaml==0.18.10 + # via + # -c requirements/base.txt + # -r requirements/base.txt + # django-setup-configuration +ruamel-yaml-clib==0.2.12 + # via + # -c requirements/base.txt + # -r requirements/base.txt + # ruamel-yaml sentry-sdk==2.13.0 # via # -c requirements/base.txt @@ -709,7 +722,7 @@ sphinx==7.4.7 # -r requirements/test-tools.in # sphinx-rtd-theme # sphinxcontrib-jquery -sphinx-rtd-theme==2.0.0 +sphinx-rtd-theme==3.0.2 # via -r requirements/test-tools.in sphinxcontrib-applehelp==2.0.0 # via sphinx diff --git a/requirements/dev.txt b/requirements/dev.txt index eaa14a3..3e9c5f1 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -319,7 +319,7 @@ django-sessionprofile==3.0.0 # -c requirements/ci.txt # -r requirements/ci.txt # open-api-framework -django-setup-configuration==0.5.0 +django-setup-configuration==0.7.1 # via # -c requirements/ci.txt # -r requirements/ci.txt @@ -375,10 +375,11 @@ djangorestframework-inclusions==1.2.0 # -c requirements/ci.txt # -r requirements/ci.txt # open-api-framework -docutils==0.20.1 +docutils==0.21.2 # via # -c requirements/ci.txt # -r requirements/ci.txt + # django-setup-configuration # sphinx # sphinx-rtd-theme drf-nested-routers==0.94.1 @@ -780,6 +781,16 @@ rpds-py==0.19.1 # -r requirements/ci.txt # jsonschema # referencing +ruamel-yaml==0.18.10 + # via + # -c requirements/ci.txt + # -r requirements/ci.txt + # django-setup-configuration +ruamel-yaml-clib==0.2.12 + # via + # -c requirements/ci.txt + # -r requirements/ci.txt + # ruamel-yaml sentry-sdk==2.13.0 # via # -c requirements/ci.txt @@ -814,7 +825,7 @@ sphinx==7.4.7 # -r requirements/ci.txt # sphinx-rtd-theme # sphinxcontrib-jquery -sphinx-rtd-theme==2.0.0 +sphinx-rtd-theme==3.0.2 # via # -c requirements/ci.txt # -r requirements/ci.txt From cbbc9ad24389325f8158e605a4de6a168af5a5b6 Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Fri, 7 Feb 2025 16:39:50 +0100 Subject: [PATCH 2/3] :arrow_up: [#43] Upgrade mozilla-django-oidc-db to 0.22.0 --- requirements/base.txt | 2 +- requirements/ci.txt | 2 +- requirements/dev.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/requirements/base.txt b/requirements/base.txt index 9f4841f..6da6f5c 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -241,7 +241,7 @@ maykin-2fa==1.0.1 # via open-api-framework mozilla-django-oidc==4.0.1 # via mozilla-django-oidc-db -mozilla-django-oidc-db==0.21.1 +mozilla-django-oidc-db==0.22.0 # via # -r requirements/base.in # open-api-framework diff --git a/requirements/ci.txt b/requirements/ci.txt index 9ee608e..b3a0d8a 100644 --- a/requirements/ci.txt +++ b/requirements/ci.txt @@ -499,7 +499,7 @@ mozilla-django-oidc==4.0.1 # -c requirements/base.txt # -r requirements/base.txt # mozilla-django-oidc-db -mozilla-django-oidc-db==0.21.1 +mozilla-django-oidc-db==0.22.0 # via # -c requirements/base.txt # -r requirements/base.txt diff --git a/requirements/dev.txt b/requirements/dev.txt index 3e9c5f1..d057546 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -555,7 +555,7 @@ mozilla-django-oidc==4.0.1 # -c requirements/ci.txt # -r requirements/ci.txt # mozilla-django-oidc-db -mozilla-django-oidc-db==0.21.1 +mozilla-django-oidc-db==0.22.0 # via # -c requirements/ci.txt # -r requirements/ci.txt From ce9f42f2229c5056b126e480abe6ca4bfaabd136 Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Fri, 7 Feb 2025 16:43:29 +0100 Subject: [PATCH 3/3] :memo: [#43] Update documentation for setup-configuration to use directive provided by the library --- docs/conf.py | 15 ++++- docs/installation/index.rst | 2 +- docs/installation/setup_configuraiton.rst | 69 ----------------------- docs/installation/setup_configuration.rst | 7 +++ 4 files changed, 22 insertions(+), 71 deletions(-) delete mode 100644 docs/installation/setup_configuraiton.rst create mode 100644 docs/installation/setup_configuration.rst diff --git a/docs/conf.py b/docs/conf.py index 8fc9776..33599a8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -8,11 +8,17 @@ import os import sys +import django +from django.utils.translation import activate + sys.path.insert(0, os.path.abspath("../src")) import referentielijsten # noqa isort:skip -# from objects.setup import setup_env # noqa isort:skip +from referentielijsten.setup import setup_env # noqa isort:skip + +setup_env() +django.setup() # TODO: This needs to be enabled when we want to use autodoc to grab # documentation from classes and functions. However, enabling django.setup() @@ -42,6 +48,9 @@ # "sphinx_tabs.tabs", # "recommonmark", # "sphinx_markdown_tables", + "sphinx.ext.autodoc", + "django_setup_configuration.documentation.setup_config_example", + "django_setup_configuration.documentation.setup_config_usage", ] # Add any paths that contain templates here, relative to this directory. @@ -54,6 +63,10 @@ # Usually you set "language" from the command line for these cases. language = "en" +# Also set the language to English for Django, to make sure that any translatable text +# is also shown in English (for instance the help texts for setup configuration examples) +activate("en") + # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. diff --git a/docs/installation/index.rst b/docs/installation/index.rst index 48d1d4b..1b68f60 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -15,4 +15,4 @@ this. :caption: Further reading config - setup_configuraiton + setup_configuration diff --git a/docs/installation/setup_configuraiton.rst b/docs/installation/setup_configuraiton.rst deleted file mode 100644 index 7e08337..0000000 --- a/docs/installation/setup_configuraiton.rst +++ /dev/null @@ -1,69 +0,0 @@ -.. _installation_configuration_cli: - -===================================== -Referentielijsten configuration (CLI) -===================================== - -After deploying Referentielijsten, it needs to be configured to be fully functional. -The django management command ``setup_configuration`` assist with this configuration. -You can get the full command documentation with: - -.. code-block:: bash - - python ./src/manage.py setup_configuration --help - -.. warning:: This command is declarative - if configuration is manually changed after - running the command and you then run the exact same command again, the manual - changes will be reverted. - -Preparation -=========== - -The command executes the list of pluggable configuration steps, and each step -requires specific configuration information, that should be prepared. -Here is the description of all available configuration steps and the configuration -format, used by each step. - -Token configuration ----------------------- - -Create a (single) YAML configuration file with your settings: - - -Mozilla-django-oidc-db ----------------------- - -Create or update the (single) YAML configuration file with your settings: - -.. code-block:: yaml - - ... - oidc_db_config_enable: true - oidc_db_config_admin_auth: - items: - - identifier: admin-oidc - oidc_rp_client_id: client-id - oidc_rp_client_secret: secret - endpoint_config: - oidc_op_discovery_endpoint: https://keycloak.local/protocol/openid-connect/ - ... - -More details about configuring mozilla-django-oidc-db through ``setup_configuration`` -can be found at the _`documentation`: https://mozilla-django-oidc-db.readthedocs.io/en/latest/setup_configuration.html. - -Execution -========= - -Referentielijsten configuration -------------------------------- - -With the full command invocation, everything is configured at once. Each configuration step -is idempotent, so any manual changes made via the admin interface will be updated if the command -is run afterwards. - -.. code-block:: bash - - python ./src/manage.py setup_configuration --yaml-file /path/to/config.yaml - -.. note:: Due to a cache-bug in the underlying framework, you need to restart all - replicas for part of this change to take effect everywhere. diff --git a/docs/installation/setup_configuration.rst b/docs/installation/setup_configuration.rst new file mode 100644 index 0000000..107dbb1 --- /dev/null +++ b/docs/installation/setup_configuration.rst @@ -0,0 +1,7 @@ +.. _installation_configuration_cli: + +===================================== +Referentielijsten configuration (CLI) +===================================== + +.. setup-config-usage::