Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
amh4r committed Nov 1, 2023
1 parent fef07ce commit 0e7d161
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,28 @@

> 🚧 Currently in beta! It hasn't been battle-tested in production environments yet.
Supported frameworks:
Our Python SDK is nearing feature parity with our [TypeScript SDK](https://github.com/inngest/inngest-js), but there are a few missing features:

- Middleware
- Idempotent logging
- Parallel steps
- Large batches

We currently support the following frameworks (but adding a new framework is easy!):

- Fast API
- Flask
- Tornado

## Usage
## Installation

```
pip install inngest
```

## Examples

> 💡 Most of these examples don't show `async` functions but you can mix `async` and non-`async` functions in the same app!
> 💡 You can mix `async` and non-`async` functions in the same app!
- [Basic](#basic-no-steps)
- [Step run](#step-run)
Expand All @@ -52,7 +65,7 @@ import requests
fn_id="find_person",
trigger=inngest.TriggerEvent(event="app/person.find"),
)
async def fetch_person(
def fetch_person(
*,
event: inngest.Event,
step: inngest.Step,
Expand Down Expand Up @@ -125,7 +138,7 @@ def fetch_ships(
}
```

### Async functions
### Async function

```py
@inngest.create_function(
Expand All @@ -143,5 +156,3 @@ async def fetch_person(
res = await client.get(f"https://swapi.dev/api/people/{person_id}")
return res.json()
```

> 💡 You can mix `async` and non-`async` functions in the same app!

0 comments on commit 0e7d161

Please sign in to comment.