Name | Canaille JSON |
Version |
0.0.78
JSON |
| download |
home_page | None |
Summary | Lightweight identity and authorization management software |
upload_time | 2025-07-25 09:47:02 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.10 |
license | Copyright (c) 2020-2023 by Yaal Coop Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
keywords |
authentication
identity
oauth
oauth2
oidc
openid
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
<div align="center">
<img src="https://gitlab.com/yaal/canaille/-/raw/main/canaille/static/img/canaille-full.webp" height="200" alt="Canaille" />
</div>
**Canaille** is a French word meaning *rascal*. It is roughly pronounced **Can I?**,
as in *Can I access your data?* Canaille is a lightweight identity and authorization management software.
It aims to be very light, simple to install and simple to maintain. Its main features are :
- User profile and groups management;
- Authentication, registration, email confirmation, "I forgot my password" emails;
- Authorization management with [OpenID Connect](https://openid.net/developers/how-connect-works) identity;
- Provisioning with [SCIM](https://scim.libre.sh);
- postgresql, mariadb and OpenLDAP first-class citizenship;
- Customizable, themable;
- The code is easy to read and easy to edit!
# Try it!
## Locally
Either run the development server
```bash
git clone https://gitlab.com/yaal/canaille.git && cd canaille
uv sync --all-extras --group devserver && uv run devserver
```
or run the Docker image
```bash
docker run -it -p 5000:5000 yaalcoop/canaille:latest
```
[Read more about installation methods](https://canaille.readthedocs.io/en/latest/tutorial/install.html).
## Online!
You have access to:
- a canaille server at [https://demo.canaille.yaal.coop](https://demo.canaille.yaal.coop)
- a dummy client at [https://demo.client1.yaal.coop](https://demo.client1.yaal.coop)
- another dummy client at [https://demo.client2.yaal.coop](https://demo.client2.yaal.coop)
Authentication details are available on the demo pages. Data is reset every night at 02:00 CEST.
# Documentation
- Please have a look on our [documentation](https://canaille.readthedocs.io);
- To **install** canaille, follow the [installation guide](https://canaille.readthedocs.io/en/latest/tutorial/install.html);
- To **contribute** to canaille, please read the [contribution guide](https://canaille.readthedocs.io/en/latest/development/contributing.html).
## Translation status
[](https://hosted.weblate.org/engage/canaille/?utm_source=widget)
Raw data
{
"_id": null,
"home_page": null,
"name": "Canaille",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "\u00c9loi Rivard <eloi@yaal.coop>",
"keywords": "authentication, identity, oauth, oauth2, oidc, openid",
"author": null,
"author_email": "Yaal Coop <contact@yaal.coop>",
"download_url": "https://files.pythonhosted.org/packages/1d/d5/301f5fa53ed4c15dbc1bd18664a8fa599ff5c2a328375e9adfb37925f8d1/canaille-0.0.78.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img src=\"https://gitlab.com/yaal/canaille/-/raw/main/canaille/static/img/canaille-full.webp\" height=\"200\" alt=\"Canaille\" />\n</div>\n\n**Canaille** is a French word meaning *rascal*. It is roughly pronounced **Can I?**,\nas in *Can I access your data?* Canaille is a lightweight identity and authorization management software.\n\nIt aims to be very light, simple to install and simple to maintain. Its main features are :\n- User profile and groups management;\n- Authentication, registration, email confirmation, \"I forgot my password\" emails;\n- Authorization management with [OpenID Connect](https://openid.net/developers/how-connect-works) identity;\n- Provisioning with [SCIM](https://scim.libre.sh);\n- postgresql, mariadb and OpenLDAP\u00a0first-class citizenship;\n- Customizable, themable;\n- The code is easy to read and easy to edit!\n\n# Try it!\n\n## Locally\n\nEither run the development server\n\n```bash\ngit clone https://gitlab.com/yaal/canaille.git && cd canaille\nuv sync --all-extras --group devserver && uv run devserver\n```\n\nor run the Docker image\n\n```bash\ndocker run -it -p 5000:5000 yaalcoop/canaille:latest\n```\n\n[Read more about installation methods](https://canaille.readthedocs.io/en/latest/tutorial/install.html).\n\n## Online!\n\nYou have access to:\n- a canaille server at [https://demo.canaille.yaal.coop](https://demo.canaille.yaal.coop)\n- a dummy client at [https://demo.client1.yaal.coop](https://demo.client1.yaal.coop)\n- another dummy client at [https://demo.client2.yaal.coop](https://demo.client2.yaal.coop)\n\nAuthentication details are available on the demo pages. Data is reset every night at 02:00 CEST.\n\n# Documentation\n\n- Please have a look on our [documentation](https://canaille.readthedocs.io);\n- To **install** canaille, follow the [installation guide](https://canaille.readthedocs.io/en/latest/tutorial/install.html);\n- To **contribute** to canaille, please read the [contribution guide](https://canaille.readthedocs.io/en/latest/development/contributing.html).\n\n## Translation status\n\n[](https://hosted.weblate.org/engage/canaille/?utm_source=widget)\n",
"bugtrack_url": null,
"license": "Copyright (c) 2020-2023 by Yaal Coop Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Lightweight identity and authorization management software",
"version": "0.0.78",
"project_urls": {
"documentation": "https://canaille.readthedocs.io/en/latest/",
"homepage": "https://canaille.yaal.coop",
"repository": "https://gitlab.com/yaal/canaille"
},
"split_keywords": [
"authentication",
" identity",
" oauth",
" oauth2",
" oidc",
" openid"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c84c9e0d6dcdbd81dfd7933427e24fa81d7f2916e682a8cd9d6d33bc13082d53",
"md5": "8c3eeb37bfc8086e88a1ace074e7a423",
"sha256": "f52413a55c99bbe1d95381386fd67ed75c84e61958c6868ed0f22a90c53b9a95"
},
"downloads": -1,
"filename": "canaille-0.0.78-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8c3eeb37bfc8086e88a1ace074e7a423",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 2388019,
"upload_time": "2025-07-25T09:47:00",
"upload_time_iso_8601": "2025-07-25T09:47:00.594087Z",
"url": "https://files.pythonhosted.org/packages/c8/4c/9e0d6dcdbd81dfd7933427e24fa81d7f2916e682a8cd9d6d33bc13082d53/canaille-0.0.78-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1dd5301f5fa53ed4c15dbc1bd18664a8fa599ff5c2a328375e9adfb37925f8d1",
"md5": "03556c3ec85be2ffdb5028e55f0ba754",
"sha256": "482d49e6ae80a58bb7efe24920af30fbc21b5f4bc08642082728113002bedc9f"
},
"downloads": -1,
"filename": "canaille-0.0.78.tar.gz",
"has_sig": false,
"md5_digest": "03556c3ec85be2ffdb5028e55f0ba754",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 2194401,
"upload_time": "2025-07-25T09:47:02",
"upload_time_iso_8601": "2025-07-25T09:47:02.880864Z",
"url": "https://files.pythonhosted.org/packages/1d/d5/301f5fa53ed4c15dbc1bd18664a8fa599ff5c2a328375e9adfb37925f8d1/canaille-0.0.78.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 09:47:02",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "yaal",
"gitlab_project": "canaille",
"lcname": "canaille"
}