|
1 | 1 | # FastAPI Cloud Tasks |
2 | 2 |
|
3 | | -Strongly typed background tasks with FastAPI and Google CloudTasks. |
| 3 | +Strongly typed background tasks with FastAPI and Google CloudTasks. This is a fork of [fastapi-gcp-tasks](https://github.com/adori/fastapi-gcp-tasks), updated with new features and bug fixes. |
4 | 4 |
|
5 | 5 | ```mermaid |
6 | 6 | sequenceDiagram |
@@ -30,7 +30,7 @@ sequenceDiagram |
30 | 30 | ## Installation |
31 | 31 |
|
32 | 32 | ``` |
33 | | -pip install fastapi-cloud-tasks |
| 33 | +pip install fastapi-gcp-tasks |
34 | 34 | ``` |
35 | 35 |
|
36 | 36 | ## Key features |
@@ -138,7 +138,7 @@ FastAPI Cloud Tasks works by putting the three together: |
138 | 138 | ### Local |
139 | 139 |
|
140 | 140 | Pre-requisites: |
141 | | -- `pip install fastapi-cloud-tasks` |
| 141 | +- `pip install fastapi-gcp-tasks` |
142 | 142 | - Install [cloud-tasks-emulator](https://github.com/aertje/cloud-tasks-emulator) |
143 | 143 | - Alternatively install ngrok and forward the server's port |
144 | 144 |
|
@@ -237,7 +237,7 @@ DelayedRoute = DelayedRouteBuilder( |
237 | 237 | pre_create_hook=oidc_task_hook( |
238 | 238 | token=tasks_v2.OidcToken( |
239 | 239 | # Service account that you created |
240 | | - service_account_email="fastapi-cloud[email protected]", |
| 240 | + service_account_email="fastapi-gcp[email protected]", |
241 | 241 | audience=base_url, |
242 | 242 | ), |
243 | 243 | ), |
@@ -369,13 +369,13 @@ Check the file [fastapi_cloud_tasks/dependencies.py](fastapi_gcp_tasks/dependenc |
369 | 369 |
|
370 | 370 | ## Contributing |
371 | 371 |
|
372 | | -- Run `pre-commit install` on your local to get pre-commit hook. |
373 | | -- Make changes and raise a PR! |
| 372 | +- Run the `format.sh` and `lint.sh` scripts before raising a PR. |
| 373 | +- Add examples and/or tests for new features. |
374 | 374 | - If the change is massive, open an issue to discuss it before writing code. |
375 | 375 |
|
376 | 376 | ## License |
377 | 377 |
|
378 | | -This project is licensed under the terms of the MIT license. This project was forked from [fastapi-cloud-tasks](https://github.com/Adori/fastapi-cloud-tasks) under the MIT license. All changes made to the original project are also licensed under the MIT license. |
| 378 | +This project is licensed under the terms of the MIT license. This project was forked from [fastapi-gcp-tasks](https://github.com/Adori/fastapi-gcp-tasks) under the MIT license. All changes made to the original project are also licensed under the MIT license. |
379 | 379 |
|
380 | 380 | ## Disclaimer |
381 | 381 |
|
|
0 commit comments