Add py.typed

Author: Jamie-Chang

html/sqlalchemy_builder/index.html

@@ -62,7 +62,8 @@ <h2 id="why">Why?</h2>
 <p>To fix this we have to assign it:</p>
 <pre><code class="language-py">statement = statement.where(...)
 </code></pre>
-<p>This can be a bit verbose though not the worst issue. By using implace <code>|=</code> we can avoid this issue without making the statement mutable.</p>
+<p>This can be a bit verbose though not the worst issue. By using implace <code>|=</code> we can avoid this issue
+without making the statement mutable.</p>
 <p>It's also just a fun syntax to play with.</p>
 </section>
 <section>

html/sqlalchemy_builder/select.html

@@ -44,6 +44,7 @@ <h1 class="title">Module <code>sqlalchemy_builder.select</code></h1>
 stmt = select(MyModel) | where(MyModel.x == 1)
 stmt |= order_by(MyModel.id)
 </code></pre>
+<p>NOTE: Only use with base <code>select</code>, <code>GenerativeSelect</code> and <code>CompoundSelect</code> may not work correctly.</p>
 <p>The following sqlalchemy operations are available:</p>
 <ul>
 <li><a href="https://docs.sqlalchemy.org/en/20/core/selectable.html#sqlalchemy.sql.expression.Select.where">where</a></li>

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sqlalchemy-builder"
-version = "0.1.0"
+version = "0.1.1"
 authors = [{ name = 'Jamie Chang', email = 'jamie.cheng.chang@gmail.com' }]
 maintainers = [{ name = 'Jamie Chang', email = 'jamie.cheng.chang@gmail.com' }]
 description = "Build SQLAlchemy statements avoiding common footguns."

sqlalchemy_builder/__init__.py

@@ -38,7 +38,8 @@
 statement = statement.where(...)
 ```
 
-This can be a bit verbose though not the worst issue. By using implace `|=` we can avoid this issue without making the statement mutable.
+This can be a bit verbose though not the worst issue. By using implace `|=` we can avoid this issue
+without making the statement mutable.
 
 It's also just a fun syntax to play with.
 

sqlalchemy_builder/py.typed

@@ -10,6 +10,8 @@
 stmt |= order_by(MyModel.id)
 ```
 
+NOTE: Only use with base `select`, `GenerativeSelect` and `CompoundSelect` may not work correctly.
+
 The following sqlalchemy operations are available:
 
 - [where](https://docs.sqlalchemy.org/en/20/core/selectable.html#sqlalchemy.sql.expression.Select.where)