FAQ | This is a LIVE service | Changelog

Skip to content
Snippets Groups Projects
Commit 8cd9ce7f authored by Dr Rich Wareham's avatar Dr Rich Wareham
Browse files

feat: update README and CHANGELOG to note new poetry-based packaging

parent ee3b982a
No related branches found
No related tags found
1 merge request!5Move over to using poetry for packaging and pre-commit for code checking
Pipeline #398403 passed with warnings
# Changelog # Changelog
## 0.0.4
Added:
- Repackaged using poetry.
- Aligned code style with black and isort by means of pre-commit checks.
## 0.0.3 ## 0.0.3
Added: Added:
......
...@@ -8,6 +8,17 @@ This is a library which contains: ...@@ -8,6 +8,17 @@ This is a library which contains:
* a set of permissions classes allowing the authentication information provided by the API Gateway * a set of permissions classes allowing the authentication information provided by the API Gateway
to be used in authorization decisions throughout an API-based app, to be used in authorization decisions throughout an API-based app,
## Library developer quick start
This library is packages using `poetry` and uses our [common Python CI
pipeline](https://gitlab.developers.cam.ac.uk/uis/devops/continuous-delivery/ci-templates/-/blob/master/auto-devops/python.md).
Make sue that `poetry` is installed and bootstrap your local environment via:
```console
$ poetry install
$ poetry run pre-commit install
```
## Required settings ## Required settings
The following Django settings are required to allow this library to be used: The following Django settings are required to allow this library to be used:
......
[tool.poetry] [tool.poetry]
name = "django-ucam-apigatewayauth" name = "django-ucam-apigatewayauth"
version = "0.0.3" version = "0.0.4"
description = "A Django module allow auth based on the headers passed from the API Gateway" description = "A Django module allow auth based on the headers passed from the API Gateway"
authors = ["DevOps Division, University Information Services, University of Cambridge <devops@uis.cam.ac.uk>"] authors = ["DevOps Division, University Information Services, University of Cambridge <devops@uis.cam.ac.uk>"]
license = "MIT" license = "MIT"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment