Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some corrections and extra explanation about PyPI publishing. #54

Merged
merged 1 commit into from
May 1, 2024
Merged

Add some corrections and extra explanation about PyPI publishing. #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 6 additions & 0 deletions apikeyclient/README.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading