docs updated, version updated to 0.6.0

docs/advanced/endpoint.md

@@ -192,13 +192,13 @@ class MyModel(Base):
     archived_at = Column(DateTime)  # Custom timestamp column for soft delete
 ```
 
-### Using `EndpointCreator` and `crud_router` with Custom Soft Delete Columns
+### Using `EndpointCreator` and `crud_router` with Custom Soft Delete or Update Columns
 
 When initializing `crud_router` or creating a custom `EndpointCreator`, you can pass the names of your custom soft delete columns through the `FastCRUD` initialization. This informs FastCRUD which columns to check and update for soft deletion operations.
 
 Here's an example of using `crud_router` with custom soft delete columns:
 
-```python
+```python hl_lines="11-14 20"
 from fastapi import FastAPI
 from fastcrud import FastCRUD, crud_router
 from sqlalchemy.ext.asyncio import AsyncSession
@@ -227,6 +227,37 @@ app.include_router(crud_router(
 ))
 ```
 
+You may also directly pass the names of the columns to crud_router or EndpointCreator:
+
+```python hl_lines="9 10"
+app.include_router(endpoint_creator(
+    session=async_session,
+    model=MyModel,
+    create_schema=CreateMyModelSchema,
+    update_schema=UpdateMyModelSchema,
+    delete_schema=DeleteMyModelSchema,
+    path="/mymodel",
+    tags=["MyModel"],
+    is_deleted_column='archived',
+    deleted_at_column='archived_at'
+))
+```
+
+You can also customize your `updated_at` column:
+
+```python hl_lines="9"
+app.include_router(endpoint_creator(
+    session=async_session,
+    model=MyModel,
+    create_schema=CreateMyModelSchema,
+    update_schema=UpdateMyModelSchema,
+    delete_schema=DeleteMyModelSchema,
+    path="/mymodel",
+    tags=["MyModel"],
+    updated_at_column='date_updated'
+))
+```
+
 This setup ensures that the soft delete functionality within your application utilizes the `archived` and `archived_at` columns for marking records as deleted, rather than the default `is_deleted` and `deleted_at` fields.
 
 By specifying custom column names for soft deletion, you can adapt FastCRUD to fit the design of your database models, providing a flexible solution for handling deleted records in a way that best suits your application's needs.

docs/index.md

@@ -69,7 +69,7 @@ async_session = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False
 Use `crud_router` and include it in your `FastAPI` application
 
 ```python
-from fastcrud import FastCRUD, crud_router
+from fastcrud import crud_router
 
 async def get_session() -> AsyncGenerator[AsyncSession, None]:
     async with async_session() as session:
@@ -86,7 +86,6 @@ app = FastAPI(lifespan=lifespan)
 item_router = crud_router(
     session=get_session,
     model=Item,
-    crud=FastCRUD(Item),
     create_schema=ItemSchema,
     update_schema=ItemSchema,
     path="/items",
@@ -171,7 +170,7 @@ class ItemUpdateSchema(BaseModel):
 from typing import AsyncGenerator
 
 from fastapi import FastAPI
-from fastcrud import FastCRUD, crud_router
+from fastcrud import crud_router
 from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
 from sqlalchemy.orm import sessionmaker
 
@@ -201,7 +200,6 @@ crud = FastCRUD(Item)
 item_router = crud_router(
     session=get_session,
     model=Item,
-    crud=crud,
     create_schema=ItemCreateSchema,
     update_schema=ItemUpdateSchema,
     path="/items",

docs/quick-start.md

@@ -82,8 +82,8 @@ async_session = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False
 
 Use `crud_router` and include it in your `FastAPI` application
 
-```python title="main.py" hl_lines="17-25 27"
-from fastcrud import FastCRUD, crud_router
+```python title="main.py" hl_lines="17-24 26"
+from fastcrud import crud_router
 
 # Database session dependency
 async def get_session() -> AsyncGenerator[AsyncSession, None]:
@@ -102,7 +102,6 @@ app = FastAPI(lifespan=lifespan)
 item_router = crud_router(
     session=session,
     model=Item,
-    crud=FastCRUD(Item),
     create_schema=ItemSchema,
     update_schema=ItemSchema,
     path="/items",

docs/sqlmodel.md

@@ -66,8 +66,8 @@ async_session = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False
 
 Use `crud_router` and include it in your `FastAPI` application
 
-```python title="main.py" hl_lines="17-25 27"
-from fastcrud import FastCRUD, crud_router
+```python title="main.py" hl_lines="17-24 26"
+from fastcrud import crud_router
 
 # Database session dependency
 async def get_session() -> AsyncGenerator[AsyncSession, None]:
@@ -86,7 +86,6 @@ app = FastAPI(lifespan=lifespan)
 item_router = crud_router(
     session=get_session,
     model=Item,
-    crud=FastCRUD(Item),
     create_schema=ItemSchema,
     update_schema=ItemSchema,
     path="/items",

docs/usage/endpoint.md

@@ -43,7 +43,7 @@ class ItemUpdateSchema(BaseModel):
 
 ### Step 2: Set Up FastAPI and FastCRUD
 
-Next, set up your FastAPI application and FastCRUD instances. This involves configuring the database connection and creating a CRUD instance for your model.
+Next, set up your FastAPI application, you can optionally set up a custom FastCRUD instance as well. This involves configuring the database connection.
 
 ```python
 from typing import AsyncGenerator
@@ -71,9 +71,6 @@ async def lifespan(app: FastAPI):
 
 # FastAPI app
 app = FastAPI(lifespan=lifespan)
-
-# CRUD operations setup
-crud = FastCRUD(Item)
 ```
 
 ### Step 3: Use `crud_router` to Create Endpoints
@@ -83,7 +80,6 @@ crud = FastCRUD(Item)
 item_router = crud_router(
     session=get_session,
     model=Item,
-    crud=crud,
     create_schema=ItemCreateSchema,
     update_schema=ItemUpdateSchema,
     path="/items",
@@ -176,7 +172,6 @@ from fastcrud import EndpointCreator
 endpoint_creator = EndpointCreator(
     session=get_session,
     model=YourModel,
-    crud=your_crud_instance,
     create_schema=YourCreateSchema,
     update_schema=YourUpdateSchema,
     delete_schema=YourDeleteSchema,

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fastcrud"
-version = "0.5.0"
+version = "0.6.0"
 description = "FastCRUD is a Python package for FastAPI, offering robust async CRUD operations and flexible endpoint creation utilities."
 authors = ["Igor Benav <[email protected]>"]
 license = "MIT"