From c934bc0b2be05c57752a6b1c75286f9d481fe737 Mon Sep 17 00:00:00 2001 From: Aaron Harper Date: Wed, 1 Nov 2023 10:12:40 -0400 Subject: [PATCH 1/3] Add Python 3.12 to CI --- .github/workflows/ci.yml | 10 +++++----- pyproject.toml | 3 ++- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9806458b..bcc17aca 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,7 +19,7 @@ jobs: runs-on: "ubuntu-latest" strategy: matrix: - python-version: ["3.10", "3.11"] + python-version: ["3.10", "3.11", "3.12"] steps: - uses: "actions/checkout@v2" - name: "Set up Python ${{ matrix.python-version }}" @@ -35,7 +35,7 @@ jobs: runs-on: "ubuntu-latest" strategy: matrix: - python-version: ["3.10", "3.11"] + python-version: ["3.10", "3.11", "3.12"] steps: - uses: "actions/checkout@v2" - name: "Set up Python ${{ matrix.python-version }}" @@ -51,7 +51,7 @@ jobs: runs-on: "ubuntu-latest" strategy: matrix: - python-version: ["3.10", "3.11"] + python-version: ["3.10", "3.11", "3.12"] steps: - uses: "actions/checkout@v2" - name: "Set up Python ${{ matrix.python-version }}" @@ -97,7 +97,7 @@ jobs: runs-on: "ubuntu-latest" strategy: matrix: - python-version: ["3.10", "3.11"] + python-version: ["3.10", "3.11", "3.12"] steps: - uses: "actions/checkout@v2" - name: "Set up Python ${{ matrix.python-version }}" @@ -113,7 +113,7 @@ jobs: runs-on: "ubuntu-latest" strategy: matrix: - python-version: ["3.10", "3.11"] + python-version: ["3.10", "3.11", "3.12"] steps: - uses: "actions/checkout@v2" - name: "Set up Python ${{ matrix.python-version }}" diff --git a/pyproject.toml b/pyproject.toml index 10d26f2b..9c0b0556 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,11 +4,12 @@ version = "0.1.2" description = "Python SDK for Inngest" readme = "README.md" classifiers = [ - "Development Status :: 3 - Alpha", + "Development Status :: 4 - Beta", "Framework :: Flask", "Intended Audience :: Developers", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", ] requires-python = ">=3.10" From d5980402bdd4517fa43f328bba90afa41a873d68 Mon Sep 17 00:00:00 2001 From: Aaron Harper Date: Wed, 1 Nov 2023 10:17:41 -0400 Subject: [PATCH 2/3] Add FastAPI classifier --- CONTRIBUTING.md | 2 +- README.md | 2 +- pyproject.toml | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 593d97d4..08316ea3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ make install ## Start example servers ```sh -# Fast API +# FastAPI (cd examples/fast_api && make dev) # Flask diff --git a/README.md b/README.md index 34486a95..79de30a7 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Our Python SDK is nearing feature parity with our [TypeScript SDK](https://githu We currently support the following frameworks (but adding a new framework is easy!): -- Fast API +- FastAPI - Flask - Tornado diff --git a/pyproject.toml b/pyproject.toml index 9c0b0556..32c03ac9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,6 +5,7 @@ description = "Python SDK for Inngest" readme = "README.md" classifiers = [ "Development Status :: 4 - Beta", + "Framework :: FastAPI", "Framework :: Flask", "Intended Audience :: Developers", "Programming Language :: Python :: 3.10", From ce31ec9191fee893c9cffafa0b211705435d045a Mon Sep 17 00:00:00 2001 From: Aaron Harper Date: Wed, 1 Nov 2023 10:53:45 -0400 Subject: [PATCH 3/3] Update readme --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 79de30a7..a05b3d5b 100644 --- a/README.md +++ b/README.md @@ -38,12 +38,24 @@ We currently support the following frameworks (but adding a new framework is eas - Flask - Tornado -## Installation +## Getting started -``` +Install `inngest` in your project: + +```sh pip install inngest ``` +Write a basic function and serve it (see the [basic](#basic-no-steps) example for guidance). + +Start the Dev Server (the local version of our cloud platform): + +```sh +npx inngest-cli@latest dev +``` + +Browse to http://127.0.0.1:8288 and you should see your app! Visit our docs to read more about the https://www.inngest.com/docs/local-development. + ## Examples > 💡 You can mix `async` and non-`async` functions in the same app!