From 953db199b486c0177999ae2f2408df341b3ae12e Mon Sep 17 00:00:00 2001 From: Lancetnik Date: Thu, 29 Jun 2023 20:45:43 +0300 Subject: [PATCH] add link to Propan --- README.md | 14 +++++++++++--- docs/docs/index.md | 12 +++++++++--- docs/docs/usages.md | 2 +- docs/mkdocs.yml | 2 +- fast_depends/__about__.py | 2 +- 5 files changed, 23 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9ea123e..5abf419 100644 --- a/README.md +++ b/README.md @@ -29,14 +29,20 @@ Documentation: https://lancetnik.github.io/FastDepends/ --- FastDepends - FastAPI Dependency Injection system extracted from FastAPI and cleared of all HTTP logic. -This is a small library which provides you with the ability to use lovely Fastapi interfaces in your own +This is a small library which provides you with the ability to use lovely FastAPI interfaces in your own projects or tools. Thanks to [*fastapi*](https://fastapi.tiangolo.com/) and [*pydantic*](https://docs.pydantic.dev/) projects for this -greate functionality. This package is just a small change of the original Fastapi sources to provide DI functionality in a pyre-Python way. +greate functionality. This package is just a small change of the original FastAPI sources to provide DI functionality in a pyre-Python way. Async and sync modes are both supported. +## For why? + +This project should be extreamly helpfull to boost your not-**FastAPI** applications (even **Flask**, I know that u like some legacy). + +Also the project can be a core of your own framework for anything. Actually, it was build for my another project - [**Propan**](https://github.com/Lancetnik/Propan), check it to see full-featured **FastDepends** usage example. + ## Installation ```bash @@ -50,6 +56,7 @@ There is no way to make Dependency Injection easier You can use this library without any frameworks in both **sync** and **async** code. ### Async code + ```python import asyncio @@ -70,6 +77,7 @@ assert asyncio.run(main("1", 2)) == 4.0 ``` ### Sync code + ```python from fast_depends import inject, Depends @@ -101,7 +109,7 @@ Synchronous code is fully supported in this package: without any `async_to_sync` Also, *FastDepends* casts functions' return values the same way, it can be very helpful in building your own tools. -These are two main defferences from native Fastapi DI System. +These are two main defferences from native FastAPI DI System. --- diff --git a/docs/docs/index.md b/docs/docs/index.md index 43efbeb..e0a93be 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -26,14 +26,20 @@ hide: FastDepends - FastAPI Dependency Injection system extracted from FastAPI and cleared of all HTTP logic. -This is a small library which provides you with the ability to use lovely Fastapi interfaces in your own +This is a small library which provides you with the ability to use lovely FastAPI interfaces in your own projects or tools. Thanks to [*fastapi*](https://fastapi.tiangolo.com/) and [*pydantic*](https://docs.pydantic.dev/) projects for this -greate functionality. This package is just a small change of the original Fastapi sources to provide DI functionality in a pyre-Python way. +greate functionality. This package is just a small change of the original FastAPI sources to provide DI functionality in a pyre-Python way. Async and sync modes are both supported. +## For why? + +This project should be extreamly helpfull to boost your not-**FastAPI** applications (even **Flask**, I know that u like some legacy). + +Also the project can be a core of your own framework for anything. Actually, it was build for my another project - [**Propan**](https://github.com/Lancetnik/Propan), check it to see full-featured **FastDepends** usage example. + ## Installation
@@ -70,7 +76,7 @@ You can use this library without any frameworks in both **sync** and **async** c Also, *FastDepends* casts functions' return values the same way, it can be very helpful in building your own tools. - These are two main defferences from native Fastapi DI System. + These are two main defferences from native FastAPI DI System. ## Custom Fields diff --git a/docs/docs/usages.md b/docs/docs/usages.md index b9e96f6..95fbc55 100644 --- a/docs/docs/usages.md +++ b/docs/docs/usages.md @@ -29,4 +29,4 @@ As you can see above, library, some middlewares and supporting classes... And yo !!! note If you are interested in using `FastDepends` in other frameworks, please take a look - at my own [**Propan**](https://lancetnik.github.io/Propan/) framework for working with various Message Brokers. \ No newline at end of file + at my own [**Propan**](https://lancetnik.github.io/Propan/) framework for working with various Message Brokers. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ece48d9..cfd8585 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,5 +1,5 @@ site_name: FastDepends -site_description: FastDepends - extracted and cleared from HTTP domain logic Fastapi Dependency Injection System +site_description: FastDepends - extracted and cleared from HTTP domain logic FastAPI Dependency Injection System site_url: https://lancetnik.github.io/FastDepends/ dev_addr: 0.0.0.0:8000 diff --git a/fast_depends/__about__.py b/fast_depends/__about__.py index f9dfd8e..c7fed03 100644 --- a/fast_depends/__about__.py +++ b/fast_depends/__about__.py @@ -1,3 +1,3 @@ -"""FastDepends - extracted and cleared from HTTP domain Fastapi Dependency Injection System""" +"""FastDepends - extracted and cleared from HTTP domain FastAPI Dependency Injection System""" __version__ = "2.0.5"