Merge branch 'main' into fix-lte

Author: tiangolo

.github/dependabot.yml

@@ -1,5 +1,11 @@
 version: 2
 updates:
+  # GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  # Python
   - package-ecosystem: "pip"
     directory: "/"
     schedule:

.github/workflows/build-docs.yml

@@ -1,6 +1,8 @@
 name: Build Docs
 on:
   push:
+    branches:
+      - main
   pull_request:
     types: [opened, synchronize]
   workflow_dispatch:

.github/workflows/test.yml

@@ -2,6 +2,8 @@ name: Test
 
 on:
   push:
+    branches:
+      - main
   pull_request:
     types: [opened, synchronize]
   workflow_dispatch:
@@ -16,7 +18,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ["3.6.15", "3.7", "3.8", "3.9", "3.10"]
       fail-fast: false
 
     steps:
@@ -52,9 +54,9 @@ jobs:
         if: steps.cache.outputs.cache-hit != 'true'
         run: python -m poetry install
       - name: Lint
-        if: ${{ matrix.python-version != '3.6' }}
+        if: ${{ matrix.python-version != '3.6.15' }}
         run: python -m poetry run bash scripts/lint.sh
       - name: Test
         run: python -m poetry run bash scripts/test.sh
       - name: Upload coverage
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v2

docs/help.md

@@ -12,7 +12,7 @@ And there are several ways to get help too.
 
 ## Subscribe to the FastAPI and Friends newsletter
 
-You can subscribe to the (infrequent) [**FastAPI and friends** newsletter](/newsletter/){.internal-link target=_blank} to stay updated about:
+You can subscribe to the (infrequent) <a href="https://fastapi.tiangolo.com/newsletter" class="external-link" target="_blank">**FastAPI and friends** newsletter</a> to stay updated about:
 
 * News about FastAPI and friends, including SQLModel 🚀
 * Guides 📝

docs/overrides/main.html

@@ -0,0 +1,31 @@
+{% extends "base.html" %}
+{%- block scripts %}
+{{ super() }}
+<script src="https://cdn.jsdelivr.net/npm/qabot@0.4"></script>
+<script>
+    // This prevents the global search from interfering with qa-bot's internal text input.
+    document.addEventListener('DOMContentLoaded', () => {
+      document.querySelectorAll('qa-bot').forEach((x) => {
+        x.addEventListener('keydown', (event) => {
+          event.stopPropagation();
+        });
+      });
+    });
+</script>
+<qa-bot 
+    server="https://tiangolo-sqlmodel.docsqa.jina.ai" 
+    theme="infer" 
+    title="SQLModel Bot"
+    description="SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness."
+    style="font-size: 0.8rem"
+>
+    <template>
+        <dl>
+            <dt>You can ask questions about SQLModel. Try:</dt>
+            <dd>Which Python version is supported?</dd>
+            <dd>How SQLModel interacts with the database?</dd>
+            <dd>How can I link tables?</dd>
+        </dl>
+    </template>
+</qa-bot>
+{%- endblock %}

docs/release-notes.md

@@ -2,6 +2,33 @@
 
 ## Latest Changes
 
+* ✏ Fix typo in `docs/tutorial/fastapi/simple-hero-api.md`. PR [#247](https://github.com/tiangolo/sqlmodel/pull/247) by [@hao-wang](https://github.com/hao-wang).
+* ✏ Fix typos in `docs/tutorial/automatic-id-none-refresh.md`, `docs/tutorial/fastapi/update.md`, `docs/tutorial/select.md`. PR [#185](https://github.com/tiangolo/sqlmodel/pull/185) by [@rootux](https://github.com/rootux).
+* ✏ Fix typo in `docs/databases.md`. PR [#177](https://github.com/tiangolo/sqlmodel/pull/177) by [@seandlg](https://github.com/seandlg).
+* ✏ Fix typos in `docs/tutorial/fastapi/update.md`. PR [#162](https://github.com/tiangolo/sqlmodel/pull/162) by [@wmcgee3](https://github.com/wmcgee3).
+* ✏ Fix typos in `docs/tutorial/code-structure.md`, `docs/tutorial/fastapi/multiple-models.md`, `docs/tutorial/fastapi/simple-hero-api.md`, `docs/tutorial/many-to-many/index.md`. PR [#116](https://github.com/tiangolo/sqlmodel/pull/116) by [@moonso](https://github.com/moonso).
+* ✏ Fix typo in `docs/tutorial/fastapi/teams.md`. PR [#154](https://github.com/tiangolo/sqlmodel/pull/154) by [@chrisgoddard](https://github.com/chrisgoddard).
+* ✏ Fix typo variable in example about relationships and `back_populates`, always use `hero` instead of `owner`. PR [#120](https://github.com/tiangolo/sqlmodel/pull/120) by [@onionj](https://github.com/onionj).
+* ✏ Fix typo in `docs/tutorial/fastapi/tests.md`. PR [#113](https://github.com/tiangolo/sqlmodel/pull/113) by [@feanil](https://github.com/feanil).
+* ✏ Fix typo in `docs/tutorial/where.md`. PR [#72](https://github.com/tiangolo/sqlmodel/pull/72) by [@ZettZet](https://github.com/ZettZet).
+* ✏ Fix typo in `docs/tutorial/code-structure.md`. PR [#91](https://github.com/tiangolo/sqlmodel/pull/91) by [@dhiraj](https://github.com/dhiraj).
+* ✏ Fix broken link to newsletter sign-up in `docs/help.md`. PR [#84](https://github.com/tiangolo/sqlmodel/pull/84) by [@mborus](https://github.com/mborus).
+* ⬆ Update development requirement for FastAPI from `^0.68.0` to `^0.68.1`. PR [#48](https://github.com/tiangolo/sqlmodel/pull/48) by [@alucarddelta](https://github.com/alucarddelta).
+* ✏ Fix typos in `docs/tutorial/many-to-many/create-models-with-link.md`. PR [#45](https://github.com/tiangolo/sqlmodel/pull/45) by [@xginn8](https://github.com/xginn8).
+* ✨ Raise an exception when using a Pydantic field type with no matching SQLAlchemy type. PR [#18](https://github.com/tiangolo/sqlmodel/pull/18) by [@elben10](https://github.com/elben10).
+* ⏪ Revert upgrade Poetry, to make a release that supports Python 3.6 first. PR [#417](https://github.com/tiangolo/sqlmodel/pull/417) by [@tiangolo](https://github.com/tiangolo).
+* 👷 Add dependabot for GitHub Actions. PR [#410](https://github.com/tiangolo/sqlmodel/pull/410) by [@tiangolo](https://github.com/tiangolo).
+* ⬆️ Upgrade Poetry to version `==1.2.0b1`. PR [#303](https://github.com/tiangolo/sqlmodel/pull/303) by [@tiangolo](https://github.com/tiangolo).
+* ✏ Fix typo in `docs/tutorial/index.md`. PR [#398](https://github.com/tiangolo/sqlmodel/pull/398) by [@ryangrose](https://github.com/ryangrose).
+* ⬆ Upgrade constrain for SQLAlchemy = ">=1.4.17,<=1.4.41". PR [#371](https://github.com/tiangolo/sqlmodel/pull/371) by [@RobertRosca](https://github.com/RobertRosca).
+* 🐛 Fix SQLAlchemy version 1.4.36 breaks SQLModel relationships (#315). PR [#322](https://github.com/tiangolo/sqlmodel/pull/322) by [@byrman](https://github.com/byrman).
+* 👷 Add CI for Python 3.10. PR [#305](https://github.com/tiangolo/sqlmodel/pull/305) by [@tiangolo](https://github.com/tiangolo).
+* 📝 Add Jina's QA Bot to the docs to help people that want to ask quick questions. PR [#263](https://github.com/tiangolo/sqlmodel/pull/263) by [@tiangolo](https://github.com/tiangolo).
+* 👷 Upgrade Codecov GitHub Action. PR [#304](https://github.com/tiangolo/sqlmodel/pull/304) by [@tiangolo](https://github.com/tiangolo).
+* ✨ Add new `Session.get()` parameter `execution_options`. PR [#302](https://github.com/tiangolo/sqlmodel/pull/302) by [@tiangolo](https://github.com/tiangolo).
+* 💚 Only run CI on push when on master, to avoid duplicate runs on PRs. PR [#244](https://github.com/tiangolo/sqlmodel/pull/244) by [@tiangolo](https://github.com/tiangolo).
+* 🔧 Upgrade MkDocs Material and update configs. PR [#217](https://github.com/tiangolo/sqlmodel/pull/217) by [@tiangolo](https://github.com/tiangolo).
+* ⬆ Upgrade mypy, fix type annotations. PR [#218](https://github.com/tiangolo/sqlmodel/pull/218) by [@tiangolo](https://github.com/tiangolo).
 
 ## 0.0.6
 

docs/tutorial/code-structure.md

@@ -8,7 +8,7 @@ The class `Hero` has a reference to the class `Team` internally.
 
 But the class `Team` also has a reference to the class `Hero`.
 
-So, if those two classes where in separate files and you tried to import the classes in each other's file directly, it would result in a **circular import**. 🔄
+So, if those two classes were in separate files and you tried to import the classes in each other's file directly, it would result in a **circular import**. 🔄
 
 And Python will not be able to handle it and will throw an error. 🚨
 
@@ -170,7 +170,7 @@ Let's assume that now the file structure is:
 
 The problem with circular imports is that Python can't resolve them at <abbr title="While it is executing the program, as oposed to the code as just text in a file stored on disk.">*runtime*</abbr>.
 
-but when using Python **type annotations** it's very common to need to declare the type of some variables with classes imported from other files.
+But when using Python **type annotations** it's very common to need to declare the type of some variables with classes imported from other files.
 
 And the files with those classes might **also need to import** more things from the first files.
 

docs/tutorial/fastapi/multiple-models.md

@@ -361,7 +361,7 @@ And because we can't leave the empty space when creating a new class, but we don
 
 This means that there's nothing else special in this class apart from the fact that it is named `HeroCreate` and that it inherits from `HeroBase`.
 
-As an alternative, we could use `HeroBase` directly in the API code instead of `HeroCreate`, but it would show up in the auomatic docs UI with that name "`HeroBase`" which could be **confusing** for clients. Instead, "`HeroCreate`" is a bit more explicit about what it is for.
+As an alternative, we could use `HeroBase` directly in the API code instead of `HeroCreate`, but it would show up in the automatic docs UI with that name "`HeroBase`" which could be **confusing** for clients. Instead, "`HeroCreate`" is a bit more explicit about what it is for.
 
 On top of that, we could easily decide in the future that we want to receive **more data** when creating a new hero apart from the data in `HeroBase` (for example a password), and now we already have the class to put those extra fields.
 

docs/tutorial/fastapi/simple-hero-api.md

@@ -23,7 +23,7 @@ $ python -m pip install fastapi "uvicorn[standard]"
 ```
 
 </div>
-s
+
 ## **SQLModel** Code - Models, Engine
 
 Now let's start with the SQLModel code.

docs/tutorial/fastapi/tests.md

@@ -311,7 +311,7 @@ Let's add some more tests:
 
     That's why we add these two extra tests here.
 
-Now, any additional test functions can be as **simple** as the first one, they just have to **declate the `client` parameter** to get the `TestClient` **fixture** with all the database stuff setup. Nice! 😎
+Now, any additional test functions can be as **simple** as the first one, they just have to **declare the `client` parameter** to get the `TestClient` **fixture** with all the database stuff setup. Nice! 😎
 
 ## Why Two Fixtures
 

docs/tutorial/fastapi/update.md

@@ -4,7 +4,7 @@ Now let's see how to update data in the database with a **FastAPI** *path operat
 
 ## `HeroUpdate` Model
 
-We want clients to be able to udpate the `name`, the `secret_name`, and the `age` of a hero.
+We want clients to be able to update the `name`, the `secret_name`, and the `age` of a hero.
 
 But we don't want them to have to include all the data again just to **update a single field**.
 
@@ -222,7 +222,7 @@ So, we would use that value and upate the `age` to `None` in the database, **jus
 
 Notice that `age` here is `None`, and **we still detected it**.
 
-Also that `name` was not even sent, and we don't *accidentaly* set it to `None` or something, we just didn't touch it, because the client didn't sent it, so we are **pefectly fine**, even in these corner cases. ✨
+Also that `name` was not even sent, and we don't *accidentally* set it to `None` or something, we just didn't touch it, because the client didn't send it, so we are **perfectly fine**, even in these corner cases. ✨
 
 These are some of the advantages of Pydantic, that we can use with SQLModel. 🎉
 

docs/tutorial/index.md

@@ -2,7 +2,7 @@
 
 ## Type hints
 
-If you need a refreshed about how to use Python type hints (type annotations), check <a href="https://fastapi.tiangolo.com/python-types/" class="external-link" target="_blank">FastAPI's Python types intro</a>.
+If you need a refresher about how to use Python type hints (type annotations), check <a href="https://fastapi.tiangolo.com/python-types/" class="external-link" target="_blank">FastAPI's Python types intro</a>.
 
 You can also check the <a href="https://mypy.readthedocs.io/en/latest/cheat_sheet_py3.html" class="external-link" target="_blank">mypy cheat sheet</a>.
 

docs/tutorial/many-to-many/create-models-with-link.md

@@ -40,7 +40,7 @@ And **both fields are primary keys**. We hadn't used this before. 🤓
 Let's see the `Team` model, it's almost identical as before, but with a little change:
 
 ```Python hl_lines="8"
-# Code above ommited 👆
+# Code above omitted 👆
 
 {!./docs_src/tutorial/many_to_many/tutorial001.py[ln:15-20]!}
 
@@ -56,7 +56,7 @@ Let's see the `Team` model, it's almost identical as before, but with a little c
 
 </details>
 
-The **relationship attribute `heroes`** is still a list of heroes, annotatted as `List["Hero"]`. Again, we use `"Hero"` in quotes because we haven't declared that class yet by this point in the code (but as you know, editors and **SQLModel** understand that).
+The **relationship attribute `heroes`** is still a list of heroes, annotated as `List["Hero"]`. Again, we use `"Hero"` in quotes because we haven't declared that class yet by this point in the code (but as you know, editors and **SQLModel** understand that).
 
 We use the same **`Relationship()`** function.
 
@@ -69,7 +69,7 @@ And here's the important part to allow the **many-to-many** relationship, we use
 Let's see the other side, here's the `Hero` model:
 
 ```Python hl_lines="9"
-# Code above ommited 👆
+# Code above omitted 👆
 
 {!./docs_src/tutorial/many_to_many/tutorial001.py[ln:23-29]!}
 
@@ -102,7 +102,7 @@ And now we have a **`link_model=HeroTeamLink`**. ✨
 The same as before, we will have the rest of the code to create the **engine**, and a function to create all the tables `create_db_and_tables()`.
 
 ```Python hl_lines="9"
-# Code above ommited 👆
+# Code above omitted 👆
 
 {!./docs_src/tutorial/many_to_many/tutorial001.py[ln:32-39]!}
 
@@ -122,7 +122,7 @@ The same as before, we will have the rest of the code to create the **engine**,
 And as in previous examples, we will add that function to a function `main()`, and we will call that `main()` function in the main block:
 
 ```Python hl_lines="4"
-# Code above ommited 👆
+# Code above omitted 👆
 
 {!./docs_src/tutorial/many_to_many/tutorial001.py[ln:78-79]!}
     # We will do more stuff here later 👈
@@ -149,7 +149,7 @@ If you run the code in the command line, it would output:
 ```console
 $ python app.py
 
-// Boilerplate ommited 😉
+// Boilerplate omitted 😉
 
 INFO Engine 
 CREATE TABLE team (

docs/tutorial/many-to-many/index.md

@@ -60,7 +60,7 @@ Notice that each hero can only have **one** connection. But each team can receiv
 
 ## Introduce Many-to-Many
 
-But let's say that as **Deadpond** is a great chracter, they recruit him to the new **Preventers** team, but he's still part of the **Z-Force** team too.
+But let's say that as **Deadpond** is a great character, they recruit him to the new **Preventers** team, but he's still part of the **Z-Force** team too.
 
 So, now, we need to be able to have a hero that is connected to **many** teams. And then, each team, should still be able to receive **many** heroes. So we need a **Many-to-Many** relationship.
 

docs/tutorial/select.md

@@ -88,7 +88,7 @@ You can try that out in **DB Browser for SQLite**:
 
 ### A SQL Shortcut
 
-If we want to get all the columns like in this case above, in SQL there's a shortcut, instead of specifying each of the column names wew could write a `*`:
+If we want to get all the columns like in this case above, in SQL there's a shortcut, instead of specifying each of the column names we could write a `*`:
 
 ```SQL
 SELECT *

docs_src/tutorial/relationship_attributes/back_populates/tutorial003.py

@@ -36,7 +36,7 @@ class Hero(SQLModel, table=True):
     team: Optional[Team] = Relationship(back_populates="heroes")
 
     weapon_id: Optional[int] = Field(default=None, foreign_key="weapon.id")
-    weapon: Optional[Weapon] = Relationship(back_populates="owner")
+    weapon: Optional[Weapon] = Relationship(back_populates="hero")
 
     powers: List[Power] = Relationship(back_populates="hero")
 

mkdocs.yml

@@ -3,6 +3,7 @@ site_description: SQLModel, SQL databases in Python, designed for simplicity, co
 site_url: https://sqlmodel.tiangolo.com/
 theme:
   name: material
+  custom_dir: docs/overrides
   palette:
   - scheme: default
     primary: deep purple
@@ -28,9 +29,6 @@ theme:
 repo_name: tiangolo/sqlmodel
 repo_url: https://github.com/tiangolo/sqlmodel
 edit_uri: ''
-google_analytics:
-    - UA-205713594-2
-    - auto
 nav:
   - SQLModel: index.md
   - features.md
@@ -104,12 +102,15 @@ markdown_extensions:
     custom_fences:
     - name: mermaid
       class: mermaid
-      format: !!python/name:pymdownx.superfences.fence_div_format ''
+      format: !!python/name:pymdownx.superfences.fence_code_format ''
 - pymdownx.tabbed:
     alternate_style: true
 - mdx_include
 
 extra:
+  analytics:
+    provider: google
+    property: UA-205713594-2
   social:
   - icon: fontawesome/brands/github-alt
     link: https://github.com/tiangolo/sqlmodel
@@ -129,6 +130,5 @@ extra_css:
   - css/custom.css
 
 extra_javascript:
-  - https://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js
   - js/termynal.js
   - js/custom.js

pyproject.toml

@@ -31,20 +31,20 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.6.1"
-SQLAlchemy = ">=1.4.17,<1.5.0"
+SQLAlchemy = ">=1.4.17,<=1.4.41"
 pydantic = "^1.8.2"
 sqlalchemy2-stubs = {version = "*", allow-prereleases = true}
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2.4"
-mypy = "^0.910"
+mypy = "0.930"
 flake8 = "^3.9.2"
 black = {version = "^21.5-beta.1", python = "^3.7"}
 mkdocs = "^1.2.1"
-mkdocs-material = "^7.1.9"
+mkdocs-material = "^8.1.4"
 mdx-include = "^1.4.1"
 coverage = {extras = ["toml"], version = "^5.5"}
-fastapi = "^0.68.0"
+fastapi = "^0.68.1"
 requests = "^2.26.0"
 autoflake = "^1.4"
 isort = "^5.9.3"
@@ -102,3 +102,5 @@ strict_equality = true
 [[tool.mypy.overrides]]
 module = "sqlmodel.sql.expression"
 warn_unused_ignores = false
+
+# invalidate CI cache: 1