update docs string

Author: LuisLuii

README.md

@@ -29,6 +29,7 @@
   - [Path Parameter](#path-parameter)
   - [Query Parameter](#query-parameter)
   - [Request Body](#request-body)
+  - [Foreign Tree](#foreign-tree)
   - [Upsert](#upsert)
   - [Add description into docs](#add-description-into-docs)
   - [Relationship](#relationship)
@@ -43,9 +44,9 @@ I believe that many people who work with FastApi to build RESTful CRUD services
 `FastAPI Quick CRUD` can generate CRUD methods in FastApi from an SQLAlchemy schema:
 
 - Get one
-- Get one with foreign key (IN DEVELOPMENT)
+- Get one with foreign key 
 - Get many
-- Get many with foreign key (IN DEVELOPMENT)
+- Get many with foreign key
 - Update one
 - Update many
 - Patch one
@@ -156,6 +157,55 @@ app.include_router(crud_route_1)
 app.include_router(crud_route_2)
 ```
 
+### Foreign Tree With Relationship
+```python
+
+class Account(Base):
+    __tablename__ = "account"
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    blog_post = relationship("BlogPost", back_populates="account")
+
+
+class BlogPost(Base):
+    __tablename__ = "blog_post"
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    account_id = Column(Integer, ForeignKey("account.id"), nullable=False)
+    account = relationship("Account", back_populates="blog_post")
+    blog_comment = relationship("BlogComment", back_populates="blog_post")
+
+
+class BlogComment(Base):
+    __tablename__ = "blog_comment"
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    blog_id = Column(Integer, ForeignKey("blog_post.id"), nullable=False)
+    blog_post = relationship("BlogPost", back_populates="blog_comment")
+
+
+crud_route_parent = crud_router_builder(
+    db_model=Account,
+    prefix="/account",
+    tags=["account"],
+    foreign_include=[BlogComment, BlogPost]
+
+)
+crud_route_child1 = generic_sql_crud_router_builder(
+    db_model=BlogPost,
+    prefix="/blog_post",
+    tags=["blog_post"],
+    foreign_include=[BlogComment]
+
+)
+crud_route_child2 = generic_sql_crud_router_builder(
+    db_model=BlogComment,
+    prefix="/blog_comment",
+    tags=["blog_comment"]
+
+)
+
+app = FastAPI()
+[app.include_router(i) for i in [crud_route_parent, crud_route_child1, crud_route_child2]]
+
+```
 
 ### SQLAlchemy to Pydantic Model Converter And Build your own API([example](https://github.com/LuisLuii/FastAPIQuickCRUD/blob/main/tutorial/basic_usage/quick_usage_with_async_SQLALchemy_Base.py))
 ```python
@@ -436,6 +486,12 @@ In the basic request body in the api generated by this tool, some fields are opt
 * [x] it is not a primary key, but the `server_default` or `default` is True
 * [x] The field is nullable
 
+
+### Foreign Tree
+TBC
+
+
+
 ## Upsert
 
 ** Upsert supports PosgreSQL only yet

src/fastapi_quickcrud/crud_router.py

@@ -22,7 +22,7 @@
 from .misc.crud_model import CRUDModel
 from .misc.memory_sql import async_memory_db, sync_memory_db
 from .misc.type import CrudMethods, SqlType
-from .misc.utils import convert_table_to_model
+from .misc.utils import convert_table_to_model, Base
 
 CRUDModelType = TypeVar("CRUDModelType", bound=BaseModel)
 CompulsoryQueryModelType = TypeVar("CompulsoryQueryModelType", bound=BaseModel)
@@ -39,34 +39,20 @@ def crud_router_builder(
         dependencies: Optional[List[callable]] = None,
         crud_models: Optional[CRUDModel] = None,
         async_mode: Optional[bool] = None,
-        foreign_include: Optional[any] = None,
+        foreign_include: Optional[Base] = None,
         sql_type: Optional[SqlType] = None,
         **router_kwargs: Any) -> APIRouter:
     """
-    :param db_session: Callable function
-        db_session should be a callable function, and return a session generator.
-        Also you can handle commit by yourelf or othe business logic
-
-        SQLAlchemy based example(SQLAlchemy was supported async since 1.4 version):
-            async:
-            async def get_transaction_session() -> AsyncSession:
-                async with async_session() as session:
-                    async with session.begin():
-                        yield session
-            sync:
-            def get_transaction_session():
-                try:
-                    db = sync_session()
-                    yield db
-                    db.commit()
-                except Exception as e:
-                    db.rollback()
-                    raise e
-                finally:
-                    db.close()
-
-
-    :param crud_methods: List[CrudMethods]
+    @param db_model:
+        The Sqlalchemy Base model/Table you want to use it to build api.
+
+    @param db_session:
+        The callable variable and return a session generator that will be used to get database connection session for fastapi.
+
+    @param autocommit:
+        set False if you handle commit in your db_session.
+
+    @param crud_methods:
         Fastapi Quick CRUD supports a few of crud methods, and they save into the Enum class,
         get it by : from fastapi_quickcrud import CrudMethods
         example:
@@ -76,21 +62,33 @@ def get_transaction_session():
             specific resource, such as GET_ONE, UPDATE_ONE, DELETE_ONE, PATCH_ONE AND POST_REDIRECT_GET
             this is because POST_REDIRECT_GET need to redirect to GET_ONE api
 
-    :param exclude_columns: List[str]
+    @param exclude_columns:
         Fastapi Quick CRUD will get all the columns in you table to generate a CRUD router,
         it is allow you exclude some columns you dont want it expose to operated by API
         note:
             if the column in exclude list but is it not nullable or no default_value, it may throw error
             when you do insert
 
-    :param crud_models:
-    :param db_model:
-        SQLAlchemy model,
-    :param dependencies:
-    :param async_mode:
-    :param autocommit:
-    :param router_kwargs:  Optional arguments that ``APIRouter().include_router`` takes.
-    :return:
+    @param dependencies:
+        A variable that will be added to the path operation decorators.
+
+    @param crud_models:
+        You can use the sqlalchemy_to_pydantic() to build your own Pydantic model CRUD set
+
+    @param async_mode:
+        As your database connection
+
+    @param foreign_include: BaseModel
+        Used to build foreign tree api
+
+    @param sql_type:
+        You sql database type
+
+    @param router_kwargs:
+        other argument for FastApi's views
+
+    @return:
+        APIRouter for fastapi
     """
 
     db_model, NO_PRIMARY_KEY = convert_table_to_model(db_model)

tutorial/foreign_tree/sample_tree.py

@@ -0,0 +1,56 @@
+from fastapi import FastAPI
+import uvicorn
+from fastapi_quickcrud import crud_router_builder
+from sqlalchemy import *
+from sqlalchemy.orm import *
+from fastapi_quickcrud.crud_router import generic_sql_crud_router_builder
+
+Base = declarative_base()
+
+
+class Account(Base):
+    __tablename__ = "account"
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    blog_post = relationship("BlogPost", back_populates="account")
+
+
+class BlogPost(Base):
+    __tablename__ = "blog_post"
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    account_id = Column(Integer, ForeignKey("account.id"), nullable=False)
+    account = relationship("Account", back_populates="blog_post")
+    blog_comment = relationship("BlogComment", back_populates="blog_post")
+
+
+class BlogComment(Base):
+    __tablename__ = "blog_comment"
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    blog_id = Column(Integer, ForeignKey("blog_post.id"), nullable=False)
+    blog_post = relationship("BlogPost", back_populates="blog_comment")
+
+
+crud_route_parent = crud_router_builder(
+    db_model=Account,
+    prefix="/account",
+    tags=["account"],
+    foreign_include=[BlogComment, BlogPost]
+
+)
+crud_route_child1 = generic_sql_crud_router_builder(
+    db_model=BlogPost,
+    prefix="/blog_post",
+    tags=["blog_post"],
+    foreign_include=[BlogComment]
+
+)
+crud_route_child2 = generic_sql_crud_router_builder(
+    db_model=BlogComment,
+    prefix="/blog_comment",
+    tags=["blog_comment"]
+
+)
+
+app = FastAPI()
+[app.include_router(i) for i in [crud_route_parent, crud_route_child1, crud_route_child2]]
+
+uvicorn.run(app, host="0.0.0.0", port=8002, debug=False)