From 1ecc1008df34fac0d65e33ab08d56e6ae0287b98 Mon Sep 17 00:00:00 2001 From: "Jens W. Klein" Date: Mon, 9 Dec 2024 14:27:52 +0100 Subject: [PATCH 1/6] newe artifact gh action --- .github/workflows/pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index d4829b3..4009810 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -43,7 +43,7 @@ jobs: run: | make docs - name: Upload artifact - uses: actions/upload-pages-artifact@v1 + uses: actions/upload-pages-artifact@v4 with: # Upload entire repository path: 'html' From 2a9bf18e2c23b2c3dbf6c4a87d3d87e2c33fa7a3 Mon Sep 17 00:00:00 2001 From: "Jens W. Klein" Date: Mon, 9 Dec 2024 14:28:57 +0100 Subject: [PATCH 2/6] bit older but existing artifact gh action --- .github/workflows/pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 4009810..8d99d88 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -43,7 +43,7 @@ jobs: run: | make docs - name: Upload artifact - uses: actions/upload-pages-artifact@v4 + uses: actions/upload-pages-artifact@v3 with: # Upload entire repository path: 'html' From 0feb855c0004f723358d2d057789e5c4ba09a4bf Mon Sep 17 00:00:00 2001 From: "Jens W. Klein" Date: Mon, 9 Dec 2024 14:35:57 +0100 Subject: [PATCH 3/6] move details to datatypes --- .../packages/edutap_wallet_google/reference.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/source/packages/edutap_wallet_google/reference.md b/source/packages/edutap_wallet_google/reference.md index 0474e46..fd5c813 100644 --- a/source/packages/edutap_wallet_google/reference.md +++ b/source/packages/edutap_wallet_google/reference.md @@ -44,9 +44,6 @@ Models can be the different top-level wallet-classes or -objects, but also issue GenericClass GenericObject - Notifications - ExpiryNotification - UpcomingNotification .. rubric:: Message @@ -118,8 +115,22 @@ Models can be the different top-level wallet-classes or -objects, but also issue ### Data-Types + ```{eval-rst} +.. currentmodule:: edutap.wallet_google.models.generic + +.. rubric:: Generic + +`edutap.wallet_google.models.generic` + +.. autosummary:: + :toctree: _autosummary + + Notifications + ExpiryNotification + UpcomingNotification + .. currentmodule:: edutap.wallet_google.models.retail .. rubric:: Retail From 038ea6ef8e4db44fab6af90edbe37e0e7e74ff51 Mon Sep 17 00:00:00 2001 From: "Jens W. Klein" Date: Mon, 9 Dec 2024 14:37:00 +0100 Subject: [PATCH 4/6] explain better --- source/packages/edutap_wallet_google/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/packages/edutap_wallet_google/index.md b/source/packages/edutap_wallet_google/index.md index 76e6cb1..71f08f0 100644 --- a/source/packages/edutap_wallet_google/index.md +++ b/source/packages/edutap_wallet_google/index.md @@ -6,7 +6,7 @@ It provides an API to - create, read, update, disable, and list Wallet Classes, Wallet Objects, and related items, - issue passes. -The package contains validating data-models made with [Pydantic](https://docs.pydantic.dev/). +The package contains validating data-models of the Google data structures made with [Pydantic](https://docs.pydantic.dev/). Behind the scenes it provides a session manager for authorized HTTPS communication with the Google Restful API. An extensible registry for additional models of classes and objects ensures extendibility. From 7f12f34f278ff16d220eae4122013b924ead58f1 Mon Sep 17 00:00:00 2001 From: "Jens W. Klein" Date: Mon, 9 Dec 2024 14:37:24 +0100 Subject: [PATCH 5/6] fix glossary --- source/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/glossary.md b/source/glossary.md index 79f2b39..7f961d2 100644 --- a/source/glossary.md +++ b/source/glossary.md @@ -1,7 +1,7 @@ (glossary)= # Glossary -`````{glossary} +```{glossary} --- sorted: --- From a0a74367cd2f40837f6ede9dfbfb9a29985c21fa Mon Sep 17 00:00:00 2001 From: "Jens W. Klein" Date: Mon, 9 Dec 2024 14:37:57 +0100 Subject: [PATCH 6/6] enhance configuration section to match main --- source/packages/edutap_wallet_google/installation.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/source/packages/edutap_wallet_google/installation.md b/source/packages/edutap_wallet_google/installation.md index eca4c7d..08498f2 100644 --- a/source/packages/edutap_wallet_google/installation.md +++ b/source/packages/edutap_wallet_google/installation.md @@ -12,6 +12,12 @@ The package is hosted at the Python Package Index (PyPI) and can be installed us ## Configuration +Configuration is done using environment variables. + +If available, dotenv-files (`.env`) are respected. + +### How to connect with Google + In order to create new Wallet Classes and Wallet Objects you need to have a Google Developer account and a Google Wallet API project. To authenticate with the Google API, you need to provide a credentials file and an issuer ID. @@ -37,3 +43,8 @@ Copy the value and point the environment variable `EDUTAP_WALLET_GOOGLE_ISSUER_I ```bash export EDUTAP_WALLET_GOOGLE_ISSUER_ID=1234567890123456789 ``` + +### Debugging + +The traffic from and to Google can be logged to a file. +If the environment variable `EDUTAP_WALLET_GOOGLE_RECORD_API_CALLS_DIR` is set to a writeable directory, all traffic is recorded there.