Metadata-Version: 2.3
Name: Canaille
Version: 0.0.56
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: identity,oauth,oauth2,oidc,openid
Classifier: Development Status :: 3 - Alpha
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: flask-wtf>=1.2.1
Requires-Dist: flask>=3.0.0
Requires-Dist: pydantic-settings>=2.0.3
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-themer>=2.0.0; extra == 'front'
Requires-Dist: pycountry>=23.12.7; extra == 'front'
Requires-Dist: pytz>=2022.7; extra == 'front'
Requires-Dist: toml>=0.10.0; extra == 'front'
Requires-Dist: zxcvbn-rs-py>=0.1.1; (python_version < '3.13') and extra == 'front'
Provides-Extra: ldap
Requires-Dist: python-ldap>=3.4.0; extra == 'ldap'
Provides-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[mysql]>=2.0.23; extra == 'mysql'
Provides-Extra: oidc
Requires-Dist: authlib>=1.3.0; extra == 'oidc'
Provides-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]>=2.0.23; extra == 'postgresql'
Provides-Extra: sentry
Requires-Dist: sentry-sdk>=2.0.0; extra == 'sentry'
Provides-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="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;
- OpenID Connect identity provider;
- postgresql, mariadb and OpenLDAP first-class citizenship;
- Customizable, themable;
- The code is easy to read and easy to edit!

# Screenshots

<div align="center">
    <img src="doc/_static/login.webp" width="225" alt="Canaille login page" />
    <img src="doc/_static/profile.webp" width="225" alt="Canaille profile page" />
    <img src="doc/_static/consent.webp" width="225" alt="Canaille consent page" />
</div>

# Try it!

## Locally

```bash
cd demo
# Either run the demo locally
./run.sh
# or run the demo in docker
docker compose up
```

## [Online](https://demo.canaille.yaal.coop)!

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)

The canaille server has some default users:
- A regular user which login and password are **user**
- A moderator user which login and password are **moderator**
- An admin user which login and password are **admin**

Online demo data are reset every night at 02:00 CEST.

# Documentation

⚠ Canaille is under heavy development and may not fit a production environment yet. However, [contributions](CONTRIBUTING.rst) are welcome! ⚠

- Please have a look on our [documentation](https://canaille.readthedocs.io);
- To **install** canaille, just 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

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