https://github.com/flavien-hugs/keycloak-auth-microservice
Kaycloak Auth Microservice
https://github.com/flavien-hugs/keycloak-auth-microservice
fastapi keycloak microservice python-keycloak
Last synced: 3 months ago
JSON representation
Kaycloak Auth Microservice
- Host: GitHub
- URL: https://github.com/flavien-hugs/keycloak-auth-microservice
- Owner: flavien-hugs
- Created: 2023-12-12T18:22:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-16T19:34:52.000Z (over 1 year ago)
- Last Synced: 2025-02-03T13:44:10.819Z (4 months ago)
- Topics: fastapi, keycloak, microservice, python-keycloak
- Language: Python
- Homepage:
- Size: 3.5 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Auth Microservice with Keycloak
This project is a microservice for authentication using FastAPI and python-keycloak.
It leverages the power of Keycloak for secure and robust authentication.
### What is keycloak
[Keycloak](https://www.keycloak.org) is an open-source Identity and Access Management solution. It provides features such as Single Sign-On (SSO), user federation, and centralized authentication management.
## Run Project
To run the project locally, follow these steps:
1. Activate environment
```shell
poetry shell
```
2. Install dependencies
```shell
poetry install
```
3. Run the server
```shell
poetry run app auth runserver
or app auth runserver
or make run
```
## Run tests
Execute the following commands to run tests and check code coverage:
1. Run tests
```shell
poetry run coverage run -m pytest -v tests
```
2. Check code test coverage
```shell
poetry run coverage report -m
```
# Routes
[](docs/keycloak-demo-endpoint.webm)
Feel free to explore and extend the functionality by adding more routes and features to suit your authentication needs.
# Contributing
Contributions are welcome! If you have any ideas or improvements, please open an issue or submit a pull request.