Skip to content

Commit

Permalink
add link to Propan
Browse files Browse the repository at this point in the history
  • Loading branch information
Lancetnik committed Jun 29, 2023
1 parent b79d669 commit 953db19
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 9 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand All @@ -70,6 +77,7 @@ assert asyncio.run(main("1", 2)) == 4.0
```

### Sync code

```python
from fast_depends import inject, Depends

Expand Down Expand Up @@ -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.

---

Expand Down
12 changes: 9 additions & 3 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<div class="termy">
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/usages.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ As you can see above, library, some middlewares and supporting classes... And yo
!!! note
<a href="#"></a>
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.
at my own [**Propan**](https://lancetnik.github.io/Propan/) framework for working with various Message Brokers.
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion fast_depends/__about__.py
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit 953db19

Please sign in to comment.