From c997a811665ab2135f5838870d0f8824c7311d7d Mon Sep 17 00:00:00 2001 From: jjmurre Date: Tue, 30 Apr 2024 20:59:49 +0200 Subject: [PATCH] Add some corrections and extra explanation about PyPI publishing. --- README.md | 2 +- apikeyclient/README.md | 6 ++++++ apikeyclient/src/apikeyclient/__init__.py | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 17813a7..79a21cf 100644 --- a/README.md +++ b/README.md @@ -106,4 +106,4 @@ The Django settings variables `APIKEY_ENDPOINT` and `APIKEY_MANDATORY` (0 or 1) that are needed for the middleware component can be configured as environment variables. -Copyright 2023 Gemeente Amsterdam. All rights reserved. +Copyright 2024 Gemeente Amsterdam. All rights reserved. diff --git a/apikeyclient/README.md b/apikeyclient/README.md index a456dc6..bfc38bc 100644 --- a/apikeyclient/README.md +++ b/apikeyclient/README.md @@ -42,3 +42,9 @@ put these keys in the `APIKEY_LOCALKEYS` settings variable. This variable should contain a serialized json string with signing keys, e.g. `[{"kty": "OKP", "alg": "EdDSA", "crv": "Ed25519", "x": ""}]`. + +Publishing to PyPI +================== + +The process to publish the API Key client middleware package to PyPI has been described on the Datadiensten ADO Wiki. + diff --git a/apikeyclient/src/apikeyclient/__init__.py b/apikeyclient/src/apikeyclient/__init__.py index b959d56..931437d 100644 --- a/apikeyclient/src/apikeyclient/__init__.py +++ b/apikeyclient/src/apikeyclient/__init__.py @@ -22,7 +22,7 @@ class ApiKeyMiddleware: the API key server to fetch the public signing keys. That means it can check API keys without connectivity to the API key server. - Needs two settings: + Needs a number of settings: * APIKEY_ENDPOINT, to fetch signing keys from. Normally the /signingkeys/ endpoint from apikeyserv. * APIKEY_MANDATORY, boolean that indicates whether API keys are required.