sqlmodel 0.0.21__tar.gz → 0.0.22__tar.gz

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sqlmodel
-Version: 0.0.21
+Version: 0.0.22
 Summary: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
 Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
 Classifier: Development Status :: 4 - Beta
@@ -22,29 +22,32 @@ Classifier: Topic :: Internet
 Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Typing :: Typed
-Project-URL: Homepage, https://github.com/tiangolo/sqlmodel
+Project-URL: Homepage, https://github.com/fastapi/sqlmodel
 Project-URL: Documentation, https://sqlmodel.tiangolo.com
-Project-URL: Repository, https://github.com/tiangolo/sqlmodel
+Project-URL: Repository, https://github.com/fastapi/sqlmodel
+Project-URL: Issues, https://github.com/fastapi/sqlmodel/issues
+Project-URL: Changelog, https://sqlmodel.tiangolo.com/release-notes/
 Requires-Python: >=3.7
 Requires-Dist: SQLAlchemy<2.1.0,>=2.0.14
 Requires-Dist: pydantic<3.0.0,>=1.10.13
 Description-Content-Type: text/markdown
 
 <p align="center">
-  <a href="https://sqlmodel.tiangolo.com"><img src="https://sqlmodel.tiangolo.com/img/logo-margin/logo-margin-vector.svg" alt="SQLModel"></a>
+  <a href="https://sqlmodel.tiangolo.com"><img src="https://sqlmodel.tiangolo.com/img/logo-margin/logo-margin-vector.svg#only-light" alt="SQLModel"></a>
+
 </p>
 <p align="center">
     <em>SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.</em>
 </p>
 <p align="center">
-<a href="https://github.com/tiangolo/sqlmodel/actions?query=workflow%3ATest" target="_blank">
-    <img src="https://github.com/tiangolo/sqlmodel/workflows/Test/badge.svg" alt="Test">
+<a href="https://github.com/fastapi/sqlmodel/actions?query=workflow%3ATest" target="_blank">
+    <img src="https://github.com/fastapi/sqlmodel/workflows/Test/badge.svg" alt="Test">
 </a>
-<a href="https://github.com/tiangolo/sqlmodel/actions?query=workflow%3APublish" target="_blank">
-    <img src="https://github.com/tiangolo/sqlmodel/workflows/Publish/badge.svg" alt="Publish">
+<a href="https://github.com/fastapi/sqlmodel/actions?query=workflow%3APublish" target="_blank">
+    <img src="https://github.com/fastapi/sqlmodel/workflows/Publish/badge.svg" alt="Publish">
 </a>
-<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/tiangolo/sqlmodel" target="_blank">
-    <img src="https://coverage-badge.samuelcolvin.workers.dev/tiangolo/sqlmodel.svg" alt="Coverage">
+<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/sqlmodel" target="_blank">
+    <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/sqlmodel.svg" alt="Coverage">
 <a href="https://pypi.org/project/sqlmodel" target="_blank">
     <img src="https://img.shields.io/pypi/v/sqlmodel?color=%2334D058&label=pypi%20package" alt="Package version">
 </a>
@@ -54,7 +57,7 @@ Description-Content-Type: text/markdown
 
 **Documentation**: <a href="https://sqlmodel.tiangolo.com" target="_blank">https://sqlmodel.tiangolo.com</a>
 
-**Source Code**: <a href="https://github.com/tiangolo/sqlmodel" target="_blank">https://github.com/tiangolo/sqlmodel</a>
+**Source Code**: <a href="https://github.com/fastapi/sqlmodel" target="_blank">https://github.com/fastapi/sqlmodel</a>
 
 ---
 
@@ -96,6 +99,8 @@ As **SQLModel** is based on **Pydantic** and **SQLAlchemy**, it requires them. T
 
 ## Installation
 
+Make sure you create a <a href="https://sqlmodel.tiangolo.com/virtual-environments/" class="external-link" target="_blank">virtual environment</a>, activate it, and then install SQLModel, for example with:
+
 <div class="termy">
 
 ```console
@@ -251,4 +256,4 @@ And at the same time, ✨ it is also a **Pydantic** model ✨. You can use inher
 
 ## License
 
-This project is licensed under the terms of the [MIT license](https://github.com/tiangolo/sqlmodel/blob/main/LICENSE).
+This project is licensed under the terms of the [MIT license](https://github.com/fastapi/sqlmodel/blob/main/LICENSE).

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/README.md

@@ -1,18 +1,19 @@
 <p align="center">
-  <a href="https://sqlmodel.tiangolo.com"><img src="https://sqlmodel.tiangolo.com/img/logo-margin/logo-margin-vector.svg" alt="SQLModel"></a>
+  <a href="https://sqlmodel.tiangolo.com"><img src="https://sqlmodel.tiangolo.com/img/logo-margin/logo-margin-vector.svg#only-light" alt="SQLModel"></a>
+
 </p>
 <p align="center">
     <em>SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.</em>
 </p>
 <p align="center">
-<a href="https://github.com/tiangolo/sqlmodel/actions?query=workflow%3ATest" target="_blank">
-    <img src="https://github.com/tiangolo/sqlmodel/workflows/Test/badge.svg" alt="Test">
+<a href="https://github.com/fastapi/sqlmodel/actions?query=workflow%3ATest" target="_blank">
+    <img src="https://github.com/fastapi/sqlmodel/workflows/Test/badge.svg" alt="Test">
 </a>
-<a href="https://github.com/tiangolo/sqlmodel/actions?query=workflow%3APublish" target="_blank">
-    <img src="https://github.com/tiangolo/sqlmodel/workflows/Publish/badge.svg" alt="Publish">
+<a href="https://github.com/fastapi/sqlmodel/actions?query=workflow%3APublish" target="_blank">
+    <img src="https://github.com/fastapi/sqlmodel/workflows/Publish/badge.svg" alt="Publish">
 </a>
-<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/tiangolo/sqlmodel" target="_blank">
-    <img src="https://coverage-badge.samuelcolvin.workers.dev/tiangolo/sqlmodel.svg" alt="Coverage">
+<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/fastapi/sqlmodel" target="_blank">
+    <img src="https://coverage-badge.samuelcolvin.workers.dev/fastapi/sqlmodel.svg" alt="Coverage">
 <a href="https://pypi.org/project/sqlmodel" target="_blank">
     <img src="https://img.shields.io/pypi/v/sqlmodel?color=%2334D058&label=pypi%20package" alt="Package version">
 </a>
@@ -22,7 +23,7 @@
 
 **Documentation**: <a href="https://sqlmodel.tiangolo.com" target="_blank">https://sqlmodel.tiangolo.com</a>
 
-**Source Code**: <a href="https://github.com/tiangolo/sqlmodel" target="_blank">https://github.com/tiangolo/sqlmodel</a>
+**Source Code**: <a href="https://github.com/fastapi/sqlmodel" target="_blank">https://github.com/fastapi/sqlmodel</a>
 
 ---
 
@@ -64,6 +65,8 @@ As **SQLModel** is based on **Pydantic** and **SQLAlchemy**, it requires them. T
 
 ## Installation
 
+Make sure you create a <a href="https://sqlmodel.tiangolo.com/virtual-environments/" class="external-link" target="_blank">virtual environment</a>, activate it, and then install SQLModel, for example with:
+
 <div class="termy">
 
 ```console
@@ -219,4 +222,4 @@ And at the same time, ✨ it is also a **Pydantic** model ✨. You can use inher
 
 ## License
 
-This project is licensed under the terms of the [MIT license](https://github.com/tiangolo/sqlmodel/blob/main/LICENSE).
+This project is licensed under the terms of the [MIT license](https://github.com/fastapi/sqlmodel/blob/main/LICENSE).

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/docs_src/tutorial/automatic_id_none_refresh/annotations/en/tutorial002.md

@@ -307,8 +307,11 @@
 
 33. Print the `hero_1`.
 
-    !!! info
-        Even if the `hero_1` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
+    /// info
+
+    Even if the `hero_1` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
+
+    ///
 
     Because the `hero_1` is fresh it has all it's data available.
 
@@ -320,8 +323,11 @@
 
 34. Print the `hero_2`.
 
-    !!! info
-        Even if the `hero_2` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
+    /// info
+
+    Even if the `hero_2` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
+
+    ///
 
     Because the `hero_2` is fresh it has all it's data available.
 
@@ -333,8 +339,11 @@
 
 35. Print the `hero_3`.
 
-    !!! info
-        Even if the `hero_3` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
+    /// info
+
+    Even if the `hero_3` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
+
+    ///
 
     Because the `hero_3` is fresh it has all it's data available.
 

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/docs_src/tutorial/delete/annotations/en/tutorial002.md

@@ -14,10 +14,13 @@
 
 3. Get one hero object, expecting exactly one.
 
-    !!! tip
-        This ensures there's no more than one, and that there's exactly one, not `None`.
+    /// tip
 
-        This would never return `None`, instead it would raise an exception.
+    This ensures there's no more than one, and that there's exactly one, not `None`.
+
+    This would never return `None`, instead it would raise an exception.
+
+    ///
 
 4. Print the hero object.
 

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/docs_src/tutorial/fastapi/app_testing/tutorial001/annotations/en/test_main_004.md

@@ -22,5 +22,8 @@
 
     We tell it that with the `poolclass=StaticPool` parameter.
 
-    !!! info
-        You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
+    /// info
+
+    You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
+
+    ///

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/docs_src/tutorial/fastapi/app_testing/tutorial001_py310/annotations/en/test_main_004.md

@@ -22,5 +22,8 @@
 
     We tell it that with the `poolclass=StaticPool` parameter.
 
-    !!! info
-        You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
+    /// info
+
+    You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
+
+    ///

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/docs_src/tutorial/fastapi/app_testing/tutorial001_py39/annotations/en/test_main_004.md

@@ -22,5 +22,8 @@
 
     We tell it that with the `poolclass=StaticPool` parameter.
 
-    !!! info
-        You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
+    /// info
+
+    You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
+
+    ///

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/docs_src/tutorial/select/annotations/en/tutorial002.md

@@ -16,10 +16,13 @@
 
 7. Create a new **session** to query data.
 
-    !!! tip
-        Notice that this is a new **session** independent from the one in the other function above.
+    /// tip
 
-        But it still uses the same **engine**. We still have one engine for the whole application.
+    Notice that this is a new **session** independent from the one in the other function above.
+
+    But it still uses the same **engine**. We still have one engine for the whole application.
+
+    ///
 
 8. Use the `select()` function to create a statement selecting all the `Hero` objects.
 

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/docs_src/tutorial/update/annotations/en/tutorial002.md

@@ -13,10 +13,13 @@
 
 3. Get one hero object, expecting exactly one.
 
-    !!! tip
-        This ensures there's no more than one, and that there's exactly one, not `None`.
+    /// tip
 
-        This would never return `None`, instead it would raise an exception.
+    This ensures there's no more than one, and that there's exactly one, not `None`.
+
+    This would never return `None`, instead it would raise an exception.
+
+    ///
 
 4. Print the hero object.
 

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/docs_src/tutorial/update/annotations/en/tutorial004.md

@@ -35,12 +35,15 @@
     INFO Engine [no key 0.00020s] ('Captain North America',)
     ```
 
-    !!! tip
-        See the `BEGIN` at the top?
+    /// tip
 
-        This is SQLAlchemy automatically starting a transaction for us.
+    See the `BEGIN` at the top?
 
-        This way, we could revert the last changes (if there were some) if we wanted to, even if the SQL to create them was already sent to the database.
+    This is SQLAlchemy automatically starting a transaction for us.
+
+    This way, we could revert the last changes (if there were some) if we wanted to, even if the SQL to create them was already sent to the database.
+
+    ///
 
 7. Get one hero object for this new query.
 
@@ -98,10 +101,13 @@
     INFO Engine COMMIT
     ```
 
-    !!! tip
-        See how SQLAlchemy (that powers SQLModel) optimizes the SQL to do as much work as possible in a single batch.
+    /// tip
+
+    See how SQLAlchemy (that powers SQLModel) optimizes the SQL to do as much work as possible in a single batch.
+
+    Here it updates both heroes in a single SQL query.
 
-        Here it updates both heroes in a single SQL query.
+    ///
 
 16. Refresh the first hero.
 
@@ -115,8 +121,11 @@
     INFO Engine [generated in 0.00023s] (2,)
     ```
 
-    !!! tip
-        Because we just committed a SQL transaction with `COMMIT`, SQLAlchemy will automatically start a new transaction with `BEGIN`.
+    /// tip
+
+    Because we just committed a SQL transaction with `COMMIT`, SQLAlchemy will automatically start a new transaction with `BEGIN`.
+
+    ///
 
 17. Refresh the second hero.
 
@@ -129,8 +138,11 @@
     INFO Engine [cached since 0.001709s ago] (7,)
     ```
 
-    !!! tip
-        SQLAlchemy is still using the previous transaction, so it doesn't have to create a new one.
+    /// tip
+
+    SQLAlchemy is still using the previous transaction, so it doesn't have to create a new one.
+
+    ///
 
 18. Print the first hero, now updated.
 

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/pyproject.toml

@@ -38,12 +38,14 @@ dependencies = [
     "SQLAlchemy >=2.0.14,<2.1.0",
     "pydantic >=1.10.13,<3.0.0",
 ]
-version = "0.0.21"
+version = "0.0.22"
 
 [project.urls]
-Homepage = "https://github.com/tiangolo/sqlmodel"
+Homepage = "https://github.com/fastapi/sqlmodel"
 Documentation = "https://sqlmodel.tiangolo.com"
-Repository = "https://github.com/tiangolo/sqlmodel"
+Repository = "https://github.com/fastapi/sqlmodel"
+Issues = "https://github.com/fastapi/sqlmodel/issues"
+Changelog = "https://sqlmodel.tiangolo.com/release-notes/"
 
 [project.optional-dependencies]
 
@@ -70,14 +72,18 @@ name = "sqlmodel-slim"
 
 [tool.coverage.run]
 parallel = true
+data_file = "coverage/.coverage"
 source = [
     "docs_src",
     "tests",
     "sqlmodel",
 ]
 context = "${CONTEXT}"
+dynamic_context = "test_function"
 
 [tool.coverage.report]
+show_missing = true
+sort = "-Cover"
 exclude_lines = [
     "pragma: no cover",
     "@overload",
@@ -85,6 +91,9 @@ exclude_lines = [
     "if TYPE_CHECKING:",
 ]
 
+[tool.coverage.html]
+show_contexts = true
+
 [tool.mypy]
 strict = true
 

sqlmodel-0.0.22/requirements-docs-insiders.txt

@@ -0,0 +1,3 @@
+git+https://${TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.5.30-insiders-4.53.11
+git+https://${TOKEN}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
+git+https://${TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/requirements-docs.txt

@@ -1,18 +1,18 @@
 -e .
 -r requirements-docs-tests.txt
-mkdocs-material==9.4.7
+mkdocs-material==9.5.18
 mdx-include >=1.4.1,<2.0.0
-mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0
 mkdocs-redirects>=1.2.1,<1.3.0
 pyyaml >=5.3.1,<7.0.0
 # For Material for MkDocs, Chinese search
-jieba==0.42.1
+# jieba==0.42.1
 # For image processing by Material for MkDocs
-pillow==10.1.0
+pillow==10.3.0
 # For image processing by Material for MkDocs
 cairosvg==2.7.1
-mkdocstrings[python]==0.25.1
+# mkdocstrings[python]==0.25.1
 # Enable griffe-typingdoc once dropping Python 3.7 and upgrading typing-extensions
 # griffe-typingdoc==0.2.5
 # For griffe, it formats with black
 typer == 0.12.3
+mkdocs-macros-plugin==1.0.5

sqlmodel-0.0.22/requirements-github-actions.txt

@@ -0,0 +1,4 @@
+PyGithub>=2.3.0,<3.0.0
+pydantic>=2.5.3,<3.0.0
+pydantic-settings>=2.1.0,<3.0.0
+httpx>=0.27.0,<0.28.0

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/requirements-tests.txt

@@ -3,7 +3,7 @@
 pytest >=7.0.1,<8.0.0
 coverage[toml] >=6.2,<8.0
 mypy ==1.4.1
-ruff ==0.4.7
+ruff ==0.6.2
 # For FastAPI tests
 fastapi >=0.103.2
 httpx ==0.24.1

sqlmodel-0.0.22/scripts/deploy_docs_status.py

@@ -0,0 +1,89 @@
+import logging
+import re
+
+from github import Github
+from pydantic import SecretStr
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    github_repository: str
+    github_token: SecretStr
+    deploy_url: str | None = None
+    commit_sha: str
+    run_id: int
+    is_done: bool = False
+
+
+def main():
+    logging.basicConfig(level=logging.INFO)
+    settings = Settings()
+
+    logging.info(f"Using config: {settings.model_dump_json()}")
+    g = Github(settings.github_token.get_secret_value())
+    repo = g.get_repo(settings.github_repository)
+    use_pr = next(
+        (pr for pr in repo.get_pulls() if pr.head.sha == settings.commit_sha), None
+    )
+    if not use_pr:
+        logging.error(f"No PR found for hash: {settings.commit_sha}")
+        return
+    commits = list(use_pr.get_commits())
+    current_commit = [c for c in commits if c.sha == settings.commit_sha][0]
+    run_url = f"https://github.com/{settings.github_repository}/actions/runs/{settings.run_id}"
+    if settings.is_done and not settings.deploy_url:
+        current_commit.create_status(
+            state="success",
+            description="No Docs Changes",
+            context="deploy-docs",
+            target_url=run_url,
+        )
+        logging.info("No docs changes found")
+        return
+    if not settings.deploy_url:
+        current_commit.create_status(
+            state="pending",
+            description="Deploying Docs",
+            context="deploy-docs",
+            target_url=run_url,
+        )
+        logging.info("No deploy URL available yet")
+        return
+    current_commit.create_status(
+        state="success",
+        description="Docs Deployed",
+        context="deploy-docs",
+        target_url=run_url,
+    )
+
+    files = list(use_pr.get_files())
+    docs_files = [f for f in files if f.filename.startswith("docs/")]
+
+    deploy_url = settings.deploy_url.rstrip("/")
+    links: list[str] = []
+    for f in docs_files:
+        match = re.match(r"docs/(.*)", f.filename)
+        assert match
+        path = match.group(1)
+        if path.endswith("index.md"):
+            path = path.replace("index.md", "")
+        else:
+            path = path.replace(".md", "/")
+        link = f"{deploy_url}/{path}"
+        links.append(link)
+    links.sort()
+
+    message = f"📝 Docs preview for commit {settings.commit_sha} at: {deploy_url}"
+
+    if links:
+        message += "\n\n### Modified Pages\n\n"
+        message += "\n".join([f"* {link}" for link in links])
+
+    print(message)
+    use_pr.as_issue().create_comment(message)
+
+    logging.info("Finished")
+
+
+if __name__ == "__main__":
+    main()

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/scripts/docs.py

@@ -7,9 +7,6 @@ from http.server import HTTPServer, SimpleHTTPRequestHandler
 from importlib import metadata
 from pathlib import Path
 
-import mkdocs.commands.build
-import mkdocs.commands.serve
-import mkdocs.config
 import mkdocs.utils
 import typer
 from jinja2 import Template
@@ -68,6 +65,13 @@ def generate_readme_content() -> str:
     pre_content = content[frontmatter_end:pre_end]
     post_content = content[post_start:]
     new_content = pre_content + message + post_content
+    # Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
+    new_content = re.sub(
+        r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
+        "",
+        new_content,
+        flags=re.DOTALL,
+    )
     return new_content
 
 
@@ -100,7 +104,7 @@ def verify_readme() -> None:
 
 
 @app.command()
-def live() -> None:
+def live(dirty: bool = False) -> None:
     """
     Serve with livereload a docs site for a specific language.
 
@@ -111,8 +115,10 @@ def live() -> None:
     en.
     """
     # Enable line numbers during local development to make it easier to highlight
-    os.environ["LINENUMS"] = "true"
-    mkdocs.commands.serve.serve(dev_addr="127.0.0.1:8008")
+    args = ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008"]
+    if dirty:
+        args.append("--dirty")
+    subprocess.run(args, env={**os.environ, "LINENUMS": "true"}, check=True)
 
 
 @app.command()

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/scripts/lint.sh

@@ -5,4 +5,4 @@ set -x
 
 mypy sqlmodel
 ruff check sqlmodel tests docs_src scripts
-ruff format sqlmodel tests docs_src --check
+ruff format sqlmodel tests docs_src scripts --check

sqlmodel-0.0.22/scripts/mkdocs_hooks.py

@@ -0,0 +1,38 @@
+from typing import Any, List, Union
+
+from mkdocs.config.defaults import MkDocsConfig
+from mkdocs.structure.files import Files
+from mkdocs.structure.nav import Link, Navigation, Section
+from mkdocs.structure.pages import Page
+
+
+def generate_renamed_section_items(
+    items: List[Union[Page, Section, Link]], *, config: MkDocsConfig
+) -> List[Union[Page, Section, Link]]:
+    new_items: List[Union[Page, Section, Link]] = []
+    for item in items:
+        if isinstance(item, Section):
+            new_title = item.title
+            new_children = generate_renamed_section_items(item.children, config=config)
+            first_child = new_children[0]
+            if isinstance(first_child, Page):
+                if first_child.file.src_path.endswith("index.md"):
+                    # Read the source so that the title is parsed and available
+                    first_child.read_source(config=config)
+                    new_title = first_child.title or new_title
+            # Creating a new section makes it render it collapsed by default
+            # no idea why, so, let's just modify the existing one
+            # new_section = Section(title=new_title, children=new_children)
+            item.title = new_title
+            item.children = new_children
+            new_items.append(item)
+        else:
+            new_items.append(item)
+    return new_items
+
+
+def on_nav(
+    nav: Navigation, *, config: MkDocsConfig, files: Files, **kwargs: Any
+) -> Navigation:
+    new_items = generate_renamed_section_items(nav.items, config=config)
+    return Navigation(items=new_items, pages=nav.pages)

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/scripts/test.sh

@@ -5,5 +5,5 @@ set -x
 
 coverage run -m pytest tests
 coverage combine
-coverage report --show-missing
+coverage report
 coverage html

{sqlmodel-0.0.21 → sqlmodel-0.0.22}/sqlmodel/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.21"
+__version__ = "0.0.22"
 
 # Re-export from SQLAlchemy
 from sqlalchemy.engine import create_engine as create_engine