change examples to use lifespan instead of OnStartUp/OnShutDown

README.md

@@ -37,9 +37,11 @@ See [documentation](https://ManiMozaffar.github.io/aioclock/) for more details.
 ## A Sample Example
 
 ```python
+from collections.abc import AsyncGenerator
+from contextlib import asynccontextmanager
 import asyncio
 
-from aioclock import AioClock, At, Depends, Every, Forever, Once, OnShutDown, OnStartUp
+from aioclock import AioClock, At, Depends, Every, Forever, Once
 from aioclock.group import Group
 
 # groups.py
@@ -79,21 +81,20 @@ async def once():
     print("Just once, I get to say something. Here it goes... I love lamp.")
 
 
-# app.py
-app = AioClock()
-app.include_group(group)
-
-
-@app.task(trigger=OnStartUp())
-async def startup():
+@asynccontextmanager
+async def lifespan(aio_clock: AioClock) -> AsyncGenerator[AioClock]:
+    # starting up
     print(
         "Welcome to the Async Chronicles! Did you know a group of unicorns is called a blessing? Well, now you do!"
     )
+    yield aio_clock
+    # shuting down
+    print("Going offline. Remember, if your code is running, you better go catch it!")
 
 
-@app.task(trigger=OnShutDown())
-async def shutdown():
-    print("Going offline. Remember, if your code is running, you better go catch it!")
+# app.py
+app = AioClock(lifespan=lifespan)
+app.include_group(group)
 
 
 # main.py

docs/examples/brokers.md

@@ -3,29 +3,33 @@ You can basically run any tasks on aioclock, it could be your redis broker or ot
 AioClock offer you a unique easy way to spin up new services, without any overhead or perfomance issue!
 
 ```python
-from aioclock import AioClock, Forever, OnShutDown, Depends
+from collections.abc import AsyncGenerator
+from contextlib import asynccontextmanager
+from aioclock import AioClock, Forever, Depends
 from functools import lru_cache
 from typing import NewType
 
 BrokerType = NewType("BrokerType", ...) # your broker type ...
 
-app = AioClock()
-
 # your singleton redis instance
 @lru_cache
 def get_redis():
     ...
 
+@asynccontextmanager
+async def lifespan(aio_clock: AioClock, redis: BrokerType = Depends(get_redis)) -> AsyncGenerator[AioClock]:
+    yield aio_clock
+    await redis.disconnect()
+
+
+app = AioClock(lifespan=lifespan)
+
 
 @app.task(trigger=Forever())
 async def read_message_queue(redis: BrokerType = Depends(get_redis)):
     async for message in redis.listen("..."):
         ...
 
-
-@app.task(trigger=OnShutDown())
-async def shutdown_event(redis: BrokerType = Depends(get_redis)):
-    await redis.disconnect()
 ```
 
 One other way to do this, is to implement a trigger that automatically execute the function.

docs/index.md

@@ -27,9 +27,11 @@ AioClock is very user friendly and easy to use, it's type stated library to use
 AioClock always have a trigger, that trigger the events.
 
 ```python
+from collections.abc import AsyncGenerator
+from contextlib import asynccontextmanager
 import asyncio
 
-from aioclock import AioClock, At, Depends, Every, Forever, Once, OnShutDown, OnStartUp
+from aioclock import AioClock, At, Depends, Every, Forever, Once
 from aioclock.group import Group
 
 # groups.py
@@ -69,23 +71,19 @@ async def once():
     print("Just once, I get to say something. Here it goes... I love lamp.")
 
 
-# app.py
-app = AioClock()
-app.include_group(group)
-
 
-@app.task(trigger=OnStartUp())
-async def startup():
+@asynccontextmanager
+async def lifespan(aio_clock: AioClock) -> AsyncGenerator[AioClock]:
     print(
         "Welcome to the Async Chronicles! Did you know a group of unicorns is called a blessing? Well, now you do!"
     )
-
-
-@app.task(trigger=OnShutDown())
-async def shutdown():
+    yield aio_clock
     print("Going offline. Remember, if your code is running, you better go catch it!")
 
 
+app = AioClock(lifespan=lifespan)
+app.include_group(group)
+
 # main.py
 if __name__ == "__main__":
     asyncio.run(app.serve())

examples/app.py

@@ -1,9 +1,11 @@
 import asyncio
+from collections.abc import AsyncGenerator
+from contextlib import asynccontextmanager
 import threading
 from time import sleep
 from typing import Annotated
 
-from aioclock import AioClock, Depends, Every, Group, OnShutDown, OnStartUp
+from aioclock import AioClock, Depends, Every, Group
 
 # service1.py
 group = Group()
@@ -34,19 +36,16 @@ async def async_task(val: str = Depends(dependency)):
     print(f"{val} `async_task` {threading.current_thread().ident}")
 
 
-# app.py
-app = AioClock()
-app.include_group(group)
-
-
-@app.task(trigger=OnStartUp())
-def startup(val: str = Depends(dependency)):
+@asynccontextmanager
+async def lifespan(aio_clock: AioClock) -> AsyncGenerator[AioClock]:
     print("Welcome!")
+    yield aio_clock
+    print("Bye!")
 
 
-@app.task(trigger=OnShutDown())
-def shutdown(val: str = Depends(dependency)):
-    print("Bye!")
+# app.py
+app = AioClock(lifespan=lifespan)
+app.include_group(group)
 
 
 if __name__ == "__main__":

examples/awesome_triggers.py

@@ -1,6 +1,8 @@
 import asyncio
+from collections.abc import AsyncGenerator
+from contextlib import asynccontextmanager
 
-from aioclock import AioClock, At, Depends, Every, Forever, Once, OnShutDown, OnStartUp
+from aioclock import AioClock, At, Depends, Every, Forever, Once
 from aioclock.group import Group
 
 # groups.py
@@ -40,21 +42,18 @@ async def once():
     print("Just once, I get to say something. Here it goes... I love lamp.")
 
 
-# app.py
-app = AioClock()
-app.include_group(group)
-
-
-@app.task(trigger=OnStartUp())
-async def startup():
+@asynccontextmanager
+async def lifespan(aio_clock: AioClock) -> AsyncGenerator[AioClock]:
     print(
         "Welcome to the Async Chronicles! Did you know a group of unicorns is called a blessing? Well, now you do!"
     )
+    yield aio_clock
+    print("Going offline. Remember, if your code is running, you better go catch it!")
 
 
-@app.task(trigger=OnShutDown())
-async def shutdown():
-    print("Going offline. Remember, if your code is running, you better go catch it!")
+# app.py
+app = AioClock(lifespan=lifespan)
+app.include_group(group)
 
 
 # main.py

examples/with_fast_api.py

@@ -1,18 +1,22 @@
 import asyncio
+from collections.abc import AsyncGenerator
 from contextlib import asynccontextmanager
 
 from fastapi import FastAPI
 
 from aioclock import AioClock
 from aioclock.ext.fast import make_fastapi_router
-from aioclock.triggers import Every, OnStartUp
+from aioclock.triggers import Every
 
-clock_app = AioClock()
+
+@asynccontextmanager
+async def aioclock_lifespan(aio_clock: AioClock) -> AsyncGenerator[AioClock]:
+    print("Starting aiolcok app...")
+    yield aio_clock
+    print("Closing aiolcok app...")
 
 
-@clock_app.task(trigger=OnStartUp())
-async def startup():
-    print("Starting...")
+clock_app = AioClock(lifespan=aioclock_lifespan)
 
 
 @clock_app.task(trigger=Every(seconds=3600))