{"id":16208137,"url":"https://github.com/verdan/flask-keycloak","last_synced_at":"2025-03-19T08:30:42.376Z","repository":{"id":53664334,"uuid":"146783534","full_name":"verdan/flask-keycloak","owner":"verdan","description":"Modular Flask application, authenticated via Keycloak","archived":false,"fork":false,"pushed_at":"2021-03-20T00:01:05.000Z","size":13,"stargazers_count":8,"open_issues_count":2,"forks_count":4,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-02-28T16:56:44.130Z","etag":null,"topics":["flask","flask-keycloak","flask-modular","keycloak-client","keycloak-rest-api"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/verdan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-30T17:30:05.000Z","updated_at":"2024-09-17T18:28:03.000Z","dependencies_parsed_at":"2022-09-02T15:30:42.695Z","dependency_job_id":null,"html_url":"https://github.com/verdan/flask-keycloak","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verdan%2Fflask-keycloak","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verdan%2Fflask-keycloak/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verdan%2Fflask-keycloak/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/verdan%2Fflask-keycloak/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/verdan","download_url":"https://codeload.github.com/verdan/flask-keycloak/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243976469,"owners_count":20377691,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flask","flask-keycloak","flask-modular","keycloak-client","keycloak-rest-api"],"created_at":"2024-10-10T10:15:27.893Z","updated_at":"2025-03-19T08:30:42.027Z","avatar_url":"https://github.com/verdan.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![MIT License][license-badge]][license]\n\n## ~~ PLEAEE DON'T USE THIS. NOT BEING MAINTAINED ANYMORE, IN FAVOR OF THIS REPO: https://github.com/verdan/flaskoidc ~~\n\n# Flask Keycloak\nMinimal Flask-Keycloak application, built using the modular approach. \n\n## Features:\n- Modular architecture\n- Authentication using keycloak\n- Separate production and development configurations and clients' secrets files\n\nGetting Started\n---------------\n\nI'm assuming you have Python installed. It is preferable to have a virtual environment for the project libraries.\nAlso assuming you've git setup on your system.\n\nSetting Up the Keycloak Server\n------------------------------\nRefer to the following documentation to create the Keycloak client. [OIDC Clients](https://www.keycloak.org/docs/3.0/server_admin/topics/clients/client-oidc.html)\nBy default this template uses the following values:\n\n- Realm Name: flask-demo\n- Client Name: flask-client\n- Client Secret: '0a55e3fd-5c30-44ec-b623-26b69ff23f45' (this is auto-generated, please change it in `config/client_secrets_[dev/prod].json` accordingly)\n\nPlease make sure to update the configurations if you are not using the above mentioned values (and for production)\n\n`1: config/client_secrets_dev.json or/and config/client_secrets_prod.json`\n\n`2: config/configurations.py`\n\n\nSetting Up the Virtual Environment\n----------------------------------\n\nIf you're using pip to install packages (and I can't see why you wouldn't), you can get both virtualenv and virtualenvwrapper by simply installing the latter.\n\n            pip install virtualenvwrapper\n\nAfter it's installed, add the following lines to your shell's start-up file (.zshrc, .bashrc, .profile, etc).\n\n            export WORKON_HOME=$HOME/.virtualenvs\n            export PROJECT_HOME=$HOME/directory-you-do-development-in\n            source /usr/local/bin/virtualenvwrapper.sh\n\nReload your start up file (e.g. source .bashrc) and you're ready to go.\n\nCreating a virtual environment is simple. Just type\n\n            mkvirtualenv flask-keycloak\n\nor If already created the Virtual Environment, just start the environment by typing\n\n            workon flask-keycloak\n            \n\nGetting the App Running\n-----------------------\n\nInstalling Python Packages and getting the app running is just like eating chocolate.\n\n            cd /path/where/you/want/your/project\n            git clone git@github.com:verdan/flask-keycloak.git\n            cd flask-keycloak/\n            \nPackages can be installed using pip command.\nThis command installs the packages in the requirement file.\n            \n            pip install -r requirements.txt\n            \nStart the Server\n            \n            flask run\n\n\nAPI URLs\n-----------------------\n            \n            http://localhost:5000/portal/api/docs\n            http://localhost:5000/portal/api/spec\n\n\n[license-badge]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat\n[license]: https://github.com/verdan/service-catalog/blob/master/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fverdan%2Fflask-keycloak","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fverdan%2Fflask-keycloak","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fverdan%2Fflask-keycloak/lists"}