Metadata-Version: 2.4
Name: Canaille
Version: 0.1.0
Summary: Lightweight identity and authorization management software
Project-URL: homepage, https://canaille.yaal.coop
Project-URL: documentation, https://canaille.readthedocs.io/en/latest/
Project-URL: repository, https://gitlab.com/yaal/canaille
Author-email: Yaal Coop <contact@yaal.coop>
Maintainer-email: Éloi Rivard <eloi@yaal.coop>
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.
License-File: LICENSE.rst
Keywords: authentication,identity,oauth,oauth2,oidc,openid
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory :: LDAP
Requires-Python: >=3.10
Requires-Dist: blinker>=1.9.0
Requires-Dist: click>=8.2.0
Requires-Dist: dramatiq-eager-broker>=0.1.0
Requires-Dist: dramatiq>=1.18.0
Requires-Dist: flask-caching>=2.3.0
Requires-Dist: flask-dramatiq>=0.6.0
Requires-Dist: flask-wtf>=1.2.1
Requires-Dist: flask>=3.0.0
Requires-Dist: httpx>=0.28.1
Requires-Dist: pika>=1.3.2
Requires-Dist: pydantic-settings>=2.8.0
Requires-Dist: wtforms>=3.1.1
Provides-Extra: front
Requires-Dist: email-validator>=2.0.0; extra == 'front'
Requires-Dist: flask-babel>=4.0.0; extra == 'front'
Requires-Dist: flask-talisman>=1.1.0; extra == 'front'
Requires-Dist: flask-themer>=2.0.0; extra == 'front'
Requires-Dist: isodate>=0.7.2; extra == 'front'
Requires-Dist: pycountry>=23.12.7; extra == 'front'
Requires-Dist: pytz>=2022.7; extra == 'front'
Requires-Dist: tomlkit>=0.13.2; extra == 'front'
Requires-Dist: zxcvbn-rs-py>=0.2.0; extra == 'front'
Provides-Extra: ldap
Requires-Dist: python-ldap>=3.4.4; extra == 'ldap'
Provides-Extra: mysql
Requires-Dist: flask-alembic>=3.1.1; extra == 'mysql'
Requires-Dist: passlib>=1.7.4; extra == 'mysql'
Requires-Dist: sqlalchemy-json>=0.7.0; extra == 'mysql'
Requires-Dist: sqlalchemy-utils>=0.41.1; extra == 'mysql'
Requires-Dist: sqlalchemy[pymysql]>=2.0.23; extra == 'mysql'
Provides-Extra: oidc
Requires-Dist: authlib>=1.6.5; extra == 'oidc'
Requires-Dist: joserfc>=1.4.0; extra == 'oidc'
Provides-Extra: otp
Requires-Dist: otpauth>=2.2.1; extra == 'otp'
Requires-Dist: pillow>=11.0.0; extra == 'otp'
Requires-Dist: qrcode>=8.0; extra == 'otp'
Provides-Extra: postgresql
Requires-Dist: flask-alembic>=3.1.1; extra == 'postgresql'
Requires-Dist: passlib>=1.7.4; extra == 'postgresql'
Requires-Dist: sqlalchemy-json>=0.7.0; extra == 'postgresql'
Requires-Dist: sqlalchemy-utils>=0.41.1; extra == 'postgresql'
Requires-Dist: sqlalchemy[postgresql-psycopg2binary]>=2.0.23; extra == 'postgresql'
Provides-Extra: rabbitmq
Requires-Dist: dramatiq[redis]>=1.18.0; extra == 'rabbitmq'
Provides-Extra: redis
Requires-Dist: dramatiq[redis]>=1.18.0; extra == 'redis'
Provides-Extra: scim
Requires-Dist: authlib>=1.5.1; extra == 'scim'
Requires-Dist: httpx>=0.28.1; extra == 'scim'
Requires-Dist: scim2-client>=0.5.1; extra == 'scim'
Requires-Dist: scim2-models>=0.4.0; extra == 'scim'
Provides-Extra: sentry
Requires-Dist: sentry-sdk>=2.0.0; extra == 'sentry'
Provides-Extra: server
Requires-Dist: asgiref>=3.9.2; extra == 'server'
Requires-Dist: hypercorn>=0.17.3; extra == 'server'
Requires-Dist: isodate>=0.7.2; extra == 'server'
Requires-Dist: pydanclick>=0.5.0; extra == 'server'
Requires-Dist: tomlkit>=0.13.2; extra == 'server'
Provides-Extra: sms
Requires-Dist: smpplib>=2.2.3; extra == 'sms'
Provides-Extra: sqlite
Requires-Dist: flask-alembic>=3.1.1; extra == 'sqlite'
Requires-Dist: passlib>=1.7.4; extra == 'sqlite'
Requires-Dist: sqlalchemy-json>=0.7.0; extra == 'sqlite'
Requires-Dist: sqlalchemy-utils>=0.41.1; extra == 'sqlite'
Requires-Dist: sqlalchemy>=2.0.23; extra == 'sqlite'
Description-Content-Type: text/markdown

<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 and OpenLDAP support;
- 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/howtos/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.client.yaal.coop](https://demo.client.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/howtos/install.html);
- To **contribute** to canaille, please read the [contribution guide](https://canaille.readthedocs.io/en/latest/development/contributing.html).

## Translation status

[![Translation status for each language](https://hosted.weblate.org/widgets/canaille/-/canaille/multi-blue.svg)](https://hosted.weblate.org/engage/canaille/?utm_source=widget)
