Skip to content

Commit

Permalink
chore: split the 'sql' package extra
Browse files Browse the repository at this point in the history
in 'sqlite', 'postgresql' and 'mysql'.
  • Loading branch information
azmeuk committed Nov 7, 2024
1 parent 216ae58 commit 61c8fa7
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Changed
^^^^^^^
- Update to HTMX 2.0.3 :pr:`184`
- Migrate from poetry to uv :pr:`187`
- The ``sql`` package extra is now split between ``sqlite``, ``postgresql`` and ``mysql``.

Removed
^^^^^^^
Expand Down
6 changes: 4 additions & 2 deletions doc/tutorial/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,17 @@ Canaille provides different package options:
- `front` provides all the things needed to produce the user interface;
- `oidc` provides the dependencies to perform OAuth2/OIDC authentication;
- `ldap` provides the dependencies to enable the LDAP backend;
- `sql` provides the dependencies to enable the Postgresql or Mysql backends;
- `sqlite` provides the dependencies to enable the SQLite backend;
- `postgresql` provides the dependencies to enable the PostgreSQL backend;
- `mysql` provides the dependencies to enable the MySQL backend;
- `sentry` provides sentry integration to watch Canaille exceptions;
- `all` provides all the extras above.

They can be installed with:

.. code-block:: bash
pip install "canaille[front,oidc,sql]"
pip install "canaille[front,oidc,postgresql]"
Configure
=========
Expand Down
16 changes: 15 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,27 @@ sentry = [
"sentry-sdk >= 2.0.0",
]

sql = [
sqlite = [
"passlib >= 1.7.4",
"sqlalchemy >= 2.0.23",
"sqlalchemy-json >= 0.7.0",
"sqlalchemy-utils >= 0.41.1",
]

postgresql = [
"passlib >= 1.7.4",
"sqlalchemy[postgresql] >= 2.0.23",
"sqlalchemy-json >= 0.7.0",
"sqlalchemy-utils >= 0.41.1",
]

mysql = [
"passlib >= 1.7.4",
"sqlalchemy[mysql] >= 2.0.23",
"sqlalchemy-json >= 0.7.0",
"sqlalchemy-utils >= 0.41.1",
]

[project.urls]
homepage = "https://canaille.yaal.coop"
documentation = "https://canaille.readthedocs.io/en/latest/"
Expand Down
65 changes: 60 additions & 5 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 61c8fa7

Please sign in to comment.