Skip to content

Commit

Permalink
Add some corrections and extra explanation about PyPI publishing.
Browse files Browse the repository at this point in the history
  • Loading branch information
jjmurre committed May 1, 2024
1 parent 373a4fd commit 65b31f5
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,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.
6 changes: 6 additions & 0 deletions apikeyclient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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": "<signing key>"}]`.


Publishing to PyPI
==================

The process to publish the API Key client middleware package to PyPI has been described on the Datadiensten ADO Wiki.

2 changes: 1 addition & 1 deletion apikeyclient/src/apikeyclient/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 65b31f5

Please sign in to comment.