Skip to content

Commit

Permalink
chores: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
raceychan committed Jan 3, 2025
1 parent 3cb1d85 commit 316bec5
Showing 1 changed file with 17 additions and 25 deletions.
42 changes: 17 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ To view viusal dependency graph, install `graphviz`
pip install ididi[graphviz]
```

## Features

- No / minial changes to your existing code
- Smart injection based on type hints with strong support to `typing` module.
- Advanced scope support
- Formated and detail-rich error messages
- Highly performant, on part with nodejs and go


## Usage

### Quick Start
Expand All @@ -57,16 +66,6 @@ await main(CreateUser(name='user'))

This would create a `UnitOfWork` instance, with a opened sqlalchemy.AsyncConnection from `conn_factory` when `main` is called. The connection will be closed when `main` is finished.

## Features

- requires no / minial changes to your existing code
- smart injection based on type hints, strong support to typing, including `typing.Union`, `typing.Annotated`, etc.
- advanced resource lifetime management with scope, name scope, context scope, etc.
- sync and async dependency resolution
- resolving functions, classes, factory functions of classes, etc.
- formated and detail-rich error messages
- highly performant, on part with nodejs and go

### Dependency factory

assign which factory method to use with `ididi.use`
Expand Down Expand Up @@ -198,26 +197,19 @@ async with dg.scope(app_name) as app_scope:
For any functions called within the request_scope, you can get the most recent scope with `dg.use_scope()`,
or its parent scopes, i.e. `dg.use_scope(app_name)` to get app_scope.

### Tutorial

check out documentation for more details

### Usage of factory

check out documentation for more details

### Visualize the dependency graph(beta)
### More

check out documentation for more details
For more detailed information, check out [Documentation](https://raceychan.github.io/ididi)

### Circular Dependency Detection
- Tutorial

check out documentation for more details
- Usage of factory

### Lazy Dependency(Beta)
- Visualize the dependency graph(beta)

check out documentation for more details
- Circular Dependency Detection

### Error context
- Lazy Dependency(Beta)

check out documentation for more details
- Error context

0 comments on commit 316bec5

Please sign in to comment.