0.7.3 fix imports (?) in .sqlalchemy, add experimental .glue, docs for .sqlalchemy

This commit is contained in:
Yusur 2025-10-18 14:48:32 +02:00
parent 7e80c84de6
commit 10e6c202f0
9 changed files with 184 additions and 70 deletions

View file

@ -1,4 +1,4 @@
suou.sqlalchemy.orm
suou.sqlalchemy.orm
===================
.. automodule:: suou.sqlalchemy.orm
@ -22,6 +22,7 @@ suou.sqlalchemy.orm
secret_column
snowflake_column
unbound_fk
username_column
want_column
.. rubric:: Classes

View file

@ -1,4 +1,4 @@
suou.waiter
suou.waiter
===========
.. automodule:: suou.waiter
@ -8,12 +8,7 @@ suou.waiter
.. autosummary::
Waiter
ko
ok
.. rubric:: Classes
.. autosummary::
Waiter

View file

@ -3,16 +3,15 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
suou documentation
SUOU
==================
SUOU (acronym for ) is a casual Python library providing utilities to
ease programmer's QoL.
SUOU (acronym for **SIS Unified Object Underarmour**) is a casual Python library providing utilities to
ease programmer's QoL and write shorter and cleaner code that works.
.. toctree::
:maxdepth: 2
sqlalchemy
api

45
docs/sqlalchemy.rst Normal file
View file

@ -0,0 +1,45 @@
sqlalchemy helpers
==================
.. currentmodule:: suou.sqlalchemy
SUOU provides several helpers to make sqlalchemy learning curve less steep.
In fact, there are pre-made column presets for a specific purpose.
Columns
-------
.. autofunction:: id_column
.. warning::
``id_column()`` expects SIQ's!
.. autofunction:: snowflake_column
.. autofunction:: match_column
.. autofunction:: secret_column
.. autofunction:: bool_column
.. autofunction:: unbound_fk
.. autofunction:: bound_fk
Column pairs
------------
.. autofunction:: age_pair
.. autofunction:: author_pair
.. autofunction:: parent_children
Misc
----
.. autofunction:: BitSelector
.. autofunction:: match_constraint
.. autofunction:: a_relationship
.. autofunction:: declarative_base
.. autofunction:: want_column