From 6ff89284c52dc88223fc72fe2d26af8776d527b7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Sat, 27 Apr 2019 20:02:32 +0400 Subject: [PATCH] :sparkles: Add FastAPI releases bot for Gitter (#189) * :fire: Remove development util script * :art: Reformat release notes with markdown-only code (no HTML) * :sparkles: Add FastAPI releases bot for Gitter --- docs/release-notes.md | 198 +++++++++++++-------------- scripts/deploy.sh | 2 + scripts/gitter_releases_bot.py | 67 +++++++++ scripts/rename_tutorial_src_files.py | 34 ----- 4 files changed, 167 insertions(+), 134 deletions(-) create mode 100644 scripts/gitter_releases_bot.py delete mode 100644 scripts/rename_tutorial_src_files.py diff --git a/docs/release-notes.md b/docs/release-notes.md index 9da246b88..3cfd7b9d1 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -4,76 +4,76 @@ * Upgrade OAuth2: * Upgrade Password flow using Bearer tokens to use the correct HTTP status code 401 `UNAUTHORIZED`, with `WWW-Authenticate` headers. - * Update, simplify, and improve all the security docs. - * Add new `scope_str` to `SecurityScopes` and update docs: OAuth2 scopes. + * Update, simplify, and improve all the [security docs](https://fastapi.tiangolo.com/tutorial/security/intro/). + * Add new `scope_str` to `SecurityScopes` and update docs: [OAuth2 scopes](https://fastapi.tiangolo.com/tutorial/security/oauth2-scopes/). * Update docs, images, tests. - * PR #188. + * PR [#188](https://github.com/tiangolo/fastapi/pull/188). -* Include Hypercorn as an alternative ASGI server in the docs. PR #187. +* Include [Hypercorn](https://gitlab.com/pgjones/hypercorn) as an alternative ASGI server in the docs. PR [#187](https://github.com/tiangolo/fastapi/pull/187). -* Add docs for Static Files and Templates. PR #186. +* Add docs for [Static Files](https://fastapi.tiangolo.com/tutorial/static-files/) and [Templates](https://fastapi.tiangolo.com/tutorial/templates/). PR [#186](https://github.com/tiangolo/fastapi/pull/186). -* Add docs for handling Response Cookies and Response Headers. PR #185. +* Add docs for handling [Response Cookies](https://fastapi.tiangolo.com/tutorial/response-cookies/) and [Response Headers](https://fastapi.tiangolo.com/tutorial/response-headers/). PR [#185](https://github.com/tiangolo/fastapi/pull/185). -* Fix typos in docs. PR #176 by @chdsbd. +* Fix typos in docs. PR [#176](https://github.com/tiangolo/fastapi/pull/176) by [@chdsbd](https://github.com/chdsbd). ## 0.19.0 -* Rename *path operation decorator* parameter `content_type` to `response_class`. PR #183. +* Rename _path operation decorator_ parameter `content_type` to `response_class`. PR [#183](https://github.com/tiangolo/fastapi/pull/183). * Add docs: - * How to use the `jsonable_encoder` in JSON compatible encoder. - * How to Return a Response directly. - * Update how to use a Custom Response Class. - * PR #184. + * How to use the `jsonable_encoder` in [JSON compatible encoder](https://fastapi.tiangolo.com/tutorial/encoder/). + * How to [Return a Response directly](https://fastapi.tiangolo.com/tutorial/response-directly/). + * Update how to use a [Custom Response Class](https://fastapi.tiangolo.com/tutorial/custom-response/). + * PR [#184](https://github.com/tiangolo/fastapi/pull/184). ## 0.18.0 -* Add docs for HTTP Basic Auth. PR #177. +* Add docs for [HTTP Basic Auth](https://fastapi.tiangolo.com/tutorial/custom-response/). PR [#177](https://github.com/tiangolo/fastapi/pull/177). -* Upgrade HTTP Basic Auth handling with automatic headers (automatic browser login prompt). PR #175. +* Upgrade HTTP Basic Auth handling with automatic headers (automatic browser login prompt). PR [#175](https://github.com/tiangolo/fastapi/pull/175). -* Update dependencies for security. PR #174. +* Update dependencies for security. PR [#174](https://github.com/tiangolo/fastapi/pull/174). -* Add docs for Middleware. PR #173. +* Add docs for [Middleware](https://fastapi.tiangolo.com/tutorial/middleware/). PR [#173](https://github.com/tiangolo/fastapi/pull/173). ## 0.17.0 -* Make Flit publish from CI. PR #170. +* Make Flit publish from CI. PR [#170](https://github.com/tiangolo/fastapi/pull/170). -* Add documentation about handling CORS (Cross-Origin Resource Sharing). PR #169. +* Add documentation about handling [CORS (Cross-Origin Resource Sharing)](https://fastapi.tiangolo.com/tutorial/cors/). PR [#169](https://github.com/tiangolo/fastapi/pull/169). -* By default, encode by alias. This allows using Pydantic `alias` parameters working by default. PR #168. +* By default, encode by alias. This allows using Pydantic `alias` parameters working by default. PR [#168](https://github.com/tiangolo/fastapi/pull/168). ## 0.16.0 -* Upgrade *path operation* `doctsring` parsing to support proper Markdown descriptions. New documentation at Path Operation Configuration. PR #163. +* Upgrade _path operation_ `doctsring` parsing to support proper Markdown descriptions. New documentation at [Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#description-from-docstring). PR [#163](https://github.com/tiangolo/fastapi/pull/163). -* Refactor internal usage of Pydantic to use correct data types. PR #164. +* Refactor internal usage of Pydantic to use correct data types. PR [#164](https://github.com/tiangolo/fastapi/pull/164). -* Upgrade Pydantic to version `0.23`. PR #160 by @euri10. +* Upgrade Pydantic to version `0.23`. PR [#160](https://github.com/tiangolo/fastapi/pull/160) by [@euri10](https://github.com/euri10). -* Fix typo in Tutorial about Extra Models. PR #159 by @danielmichaels. +* Fix typo in Tutorial about Extra Models. PR [#159](https://github.com/tiangolo/fastapi/pull/159) by [@danielmichaels](https://github.com/danielmichaels). -* Fix Query Parameters URL examples in docs. PR #157 by @hayata-yamamoto. +* Fix [Query Parameters](https://fastapi.tiangolo.com/tutorial/query-params/) URL examples in docs. PR [#157](https://github.com/tiangolo/fastapi/pull/157) by [@hayata-yamamoto](https://github.com/hayata-yamamoto). ## 0.15.0 -* Add support for multiple file uploads (as a single form field). New docs at: Multiple file uploads. PR #158. +* Add support for multiple file uploads (as a single form field). New docs at: [Multiple file uploads](https://fastapi.tiangolo.com/tutorial/request-files/#multiple-file-uploads). PR [#158](https://github.com/tiangolo/fastapi/pull/158). -* Add docs for: Additional Status Codes. PR #156. +* Add docs for: [Additional Status Codes](https://fastapi.tiangolo.com/tutorial/additional-status-codes/). PR [#156](https://github.com/tiangolo/fastapi/pull/156). ## 0.14.0 -* Improve automatically generated names of path operations in OpenAPI (in API docs). A function `read_items` instead of having a generated name "Read Items Get" will have "Read Items". PR #155. +* Improve automatically generated names of path operations in OpenAPI (in API docs). A function `read_items` instead of having a generated name "Read Items Get" will have "Read Items". PR [#155](https://github.com/tiangolo/fastapi/pull/155). -* Add docs for: Testing **FastAPI**. PR #151. +* Add docs for: [Testing **FastAPI**](https://fastapi.tiangolo.com/tutorial/testing/). PR [#151](https://github.com/tiangolo/fastapi/pull/151). -* Update `/docs` Swagger UI to enable deep linking. This allows sharing the URL pointing directly to the path operation documentation in the docs. PR #148 by @wshayes. +* Update `/docs` Swagger UI to enable deep linking. This allows sharing the URL pointing directly to the path operation documentation in the docs. PR [#148](https://github.com/tiangolo/fastapi/pull/148) by [@wshayes](https://github.com/wshayes). -* Update development dependencies, `Pipfile.lock`. PR #150. +* Update development dependencies, `Pipfile.lock`. PR [#150](https://github.com/tiangolo/fastapi/pull/150). -* Include Falcon and Hug in: Alternatives, Inspiration and Comparisons. +* Include Falcon and Hug in: [Alternatives, Inspiration and Comparisons](https://fastapi.tiangolo.com/alternatives/). ## 0.13.0 @@ -81,187 +81,185 @@ * `SecurityScopes` can be declared as a parameter like `Request`, to get the scopes of all super-dependencies/dependants. * Improve `Security` handling, merging scopes when declaring `SecurityScopes`. * Allow using `SecurityBase` (like `OAuth2`) classes with `Depends` and still document them. `Security` now is needed only to declare `scopes`. - * Updated docs about: OAuth2 with Password (and hashing), Bearer with JWT tokens. - * New docs about: OAuth2 scopes. - * PR #141. + * Updated docs about: [OAuth2 with Password (and hashing), Bearer with JWT tokens](https://fastapi.tiangolo.com/tutorial/security/oauth2-jwt/). + * New docs about: [OAuth2 scopes](https://fastapi.tiangolo.com/tutorial/security/oauth2-scopes/). + * PR [#141](https://github.com/tiangolo/fastapi/pull/141). ## 0.12.1 -* Fix bug: handling additional `responses` in `APIRouter.include_router()`. PR #140. +* Fix bug: handling additional `responses` in `APIRouter.include_router()`. PR [#140](https://github.com/tiangolo/fastapi/pull/140). -* Fix typo in SQL tutorial. PR #138 by @mostaphaRoudsari. +* Fix typo in SQL tutorial. PR [#138](https://github.com/tiangolo/fastapi/pull/138) by [@mostaphaRoudsari](https://github.com/mostaphaRoudsari). -* Fix typos in section about nested models and OAuth2 with JWT. PR #127 by @mmcloud. +* Fix typos in section about nested models and OAuth2 with JWT. PR [#127](https://github.com/tiangolo/fastapi/pull/127) by [@mmcloud](https://github.com/mmcloud). ## 0.12.0 -* Add additional `responses` parameter to *path operation decorators* to extend responses in OpenAPI (and API docs). +* Add additional `responses` parameter to _path operation decorators_ to extend responses in OpenAPI (and API docs). * It also allows extending existing responses generated from `response_model`, declare other media types (like images), etc. - * The new documentation is here: Additional Responses. - * `responses` can also be added to `.include_router()`, the updated docs are here: Bigger Applications. - * PR #97 originally initiated by @barsi. - + * The new documentation is here: [Additional Responses](https://fastapi.tiangolo.com/tutorial/additional-responses/). + * `responses` can also be added to `.include_router()`, the updated docs are here: [Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#add-some-custom-tags-and-responses). + * PR [#97](https://github.com/tiangolo/fastapi/pull/97) originally initiated by [@barsi](https://github.com/barsi). * Update `scripts/test-cov-html.sh` to allow passing extra parameters like `-vv`, for development. ## 0.11.0 -* Add `auto_error` parameter to security utility functions. Allowing them to be optional. Also allowing to have multiple alternative security schemes that are then checked in a single dependency instead of each one verifying and returning the error to the client automatically when not satisfied. PR #134. +* Add `auto_error` parameter to security utility functions. Allowing them to be optional. Also allowing to have multiple alternative security schemes that are then checked in a single dependency instead of each one verifying and returning the error to the client automatically when not satisfied. PR [#134](https://github.com/tiangolo/fastapi/pull/134). -* Update SQL Tutorial to close database sessions even when there are exceptions. PR #89 by @alexiri. +* Update [SQL Tutorial](https://fastapi.tiangolo.com/tutorial/sql-databases/#create-a-middleware-to-handle-sessions) to close database sessions even when there are exceptions. PR [#89](https://github.com/tiangolo/fastapi/pull/89) by [@alexiri](https://github.com/alexiri). -* Fix duplicate dependency in `pyproject.toml`. PR #128 by @zxalif. +* Fix duplicate dependency in `pyproject.toml`. PR [#128](https://github.com/tiangolo/fastapi/pull/128) by [@zxalif](https://github.com/zxalif). ## 0.10.3 -* Add Gitter chat, badge, links, etc. https://gitter.im/tiangolo/fastapi -. PR #117. +* Add Gitter chat, badge, links, etc. [https://gitter.im/tiangolo/fastapi](https://gitter.im/tiangolo/fastapi) . PR [#117](https://github.com/tiangolo/fastapi/pull/117). -* Add docs about Extending OpenAPI. PR #126. +* Add docs about [Extending OpenAPI](https://fastapi.tiangolo.com/tutorial/extending-openapi/). PR [#126](https://github.com/tiangolo/fastapi/pull/126). -* Make Travis run Ubuntu Xenial (newer version) and Python 3.7 instead of Python 3.7-dev. PR #92 by @blueyed. +* Make Travis run Ubuntu Xenial (newer version) and Python 3.7 instead of Python 3.7-dev. PR [#92](https://github.com/tiangolo/fastapi/pull/92) by [@blueyed](https://github.com/blueyed). -* Fix duplicated param variable creation. PR #123 by @yihuang. +* Fix duplicated param variable creation. PR [#123](https://github.com/tiangolo/fastapi/pull/123) by [@yihuang](https://github.com/yihuang). -* Add note in Response Model docs about why using a function parameter instead of a function return type annotation. PR #109 by @JHSaunders. +* Add note in [Response Model docs](https://fastapi.tiangolo.com/tutorial/response-model/) about why using a function parameter instead of a function return type annotation. PR [#109](https://github.com/tiangolo/fastapi/pull/109) by [@JHSaunders](https://github.com/JHSaunders). -* Fix event docs (startup/shutdown) function name. PR #105 by @stratosgear. +* Fix event docs (startup/shutdown) function name. PR [#105](https://github.com/tiangolo/fastapi/pull/105) by [@stratosgear](https://github.com/stratosgear). ## 0.10.2 -* Fix OpenAPI (JSON Schema) for declarations of Python `Union` (JSON Schema `additionalProperties`). PR #121. +* Fix OpenAPI (JSON Schema) for declarations of Python `Union` (JSON Schema `additionalProperties`). PR [#121](https://github.com/tiangolo/fastapi/pull/121). -* Update Background Tasks with a note on Celery. +* Update [Background Tasks](https://fastapi.tiangolo.com/tutorial/background-tasks/) with a note on Celery. -* Document response models using unions and lists, updated at: Extra Models. PR #108. +* Document response models using unions and lists, updated at: [Extra Models](https://fastapi.tiangolo.com/tutorial/extra-models/). PR [#108](https://github.com/tiangolo/fastapi/pull/108). ## 0.10.1 -* Add docs and tests for encode/databases. New docs at: Async SQL (Relational) Databases. PR #107. +* Add docs and tests for [encode/databases](https://github.com/encode/databases). New docs at: [Async SQL (Relational) Databases](https://fastapi.tiangolo.com/tutorial/async-sql-databases/). PR [#107](https://github.com/tiangolo/fastapi/pull/107). ## 0.10.0 -* Add support for Background Tasks in *path operation functions* and dependencies. New documentation about Background Tasks is here. PR #103. +* Add support for Background Tasks in _path operation functions_ and dependencies. New documentation about [Background Tasks is here](https://fastapi.tiangolo.com/tutorial/background-tasks/). PR [#103](https://github.com/tiangolo/fastapi/pull/103). -* Add support for `.websocket_route()` in `APIRouter`. PR #100 by @euri10. +* Add support for `.websocket_route()` in `APIRouter`. PR [#100](https://github.com/tiangolo/fastapi/pull/100) by [@euri10](https://github.com/euri10). -* New docs section about Events: startup - shutdown. PR #99. +* New docs section about [Events: startup - shutdown](https://fastapi.tiangolo.com/tutorial/events/). PR [#99](https://github.com/tiangolo/fastapi/pull/99). ## 0.9.1 -* Document receiving Multiple values with the same query parameter and Duplicate headers. PR #95. +* Document receiving [Multiple values with the same query parameter](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#query-parameter-list-multiple-values) and [Duplicate headers](https://fastapi.tiangolo.com/tutorial/header-params/#duplicate-headers). PR [#95](https://github.com/tiangolo/fastapi/pull/95). ## 0.9.0 -* Upgrade compatible Pydantic version to `0.21.0`. PR #90. +* Upgrade compatible Pydantic version to `0.21.0`. PR [#90](https://github.com/tiangolo/fastapi/pull/90). -* Add documentation for: Application Configuration. +* Add documentation for: [Application Configuration](https://fastapi.tiangolo.com/tutorial/application-configuration/). -* Fix typo in docs. PR #76 by @matthewhegarty. +* Fix typo in docs. PR [#76](https://github.com/tiangolo/fastapi/pull/76) by [@matthewhegarty](https://github.com/matthewhegarty). * Fix link in "Deployment" to "Bigger Applications". ## 0.8.0 -* Make development scripts executable. PR #76 by @euri10. +* Make development scripts executable. PR [#76](https://github.com/tiangolo/fastapi/pull/76) by [@euri10](https://github.com/euri10). -* Add support for adding `tags` in `app.include_router()`. PR #55 by @euri10. Documentation updated in the section: Bigger Applications. +* Add support for adding `tags` in `app.include_router()`. PR [#55](https://github.com/tiangolo/fastapi/pull/55) by [@euri10](https://github.com/euri10). Documentation updated in the section: [Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/). -* Update docs related to Uvicorn to use new `--reload` option from version `0.5.x`. PR #74. +* Update docs related to Uvicorn to use new `--reload` option from version `0.5.x`. PR [#74](https://github.com/tiangolo/fastapi/pull/74). -* Update `isort` imports and scripts to be compatible with newer versions. PR #75. +* Update `isort` imports and scripts to be compatible with newer versions. PR [#75](https://github.com/tiangolo/fastapi/pull/75). ## 0.7.1 -* Update technical details about `async def` handling with respect to previous frameworks. PR #64 by @haizaar. +* Update [technical details about `async def` handling](https://fastapi.tiangolo.com/async/#path-operation-functions) with respect to previous frameworks. PR [#64](https://github.com/tiangolo/fastapi/pull/64) by [@haizaar](https://github.com/haizaar). -* Add deployment documentation for Docker in Raspberry Pi and other architectures. +* Add [deployment documentation for Docker in Raspberry Pi](https://fastapi.tiangolo.com/deployment/#raspberry-pi-and-other-architectures) and other architectures. -* Trigger Docker images build on Travis CI automatically. PR #65. +* Trigger Docker images build on Travis CI automatically. PR [#65](https://github.com/tiangolo/fastapi/pull/65). ## 0.7.0 * Add support for `UploadFile` in `File` parameter annotations. * This includes a file-like interface. - * Here's the updated documentation for declaring `File` parameters with `UploadFile`. - * And here's the updated documentation for using `Form` parameters mixed with `File` parameters, supporting `bytes` and `UploadFile` at the same time. - * PR #63. + * Here's the updated documentation for declaring [`File` parameters with `UploadFile`](https://fastapi.tiangolo.com/tutorial/request-files/#file-parameters-with-uploadfile). + * And here's the updated documentation for using [`Form` parameters mixed with `File` parameters, supporting `bytes` and `UploadFile`](https://fastapi.tiangolo.com/tutorial/request-forms-and-files/) at the same time. + * PR [#63](https://github.com/tiangolo/fastapi/pull/63). ## 0.6.4 -* Add technical details about `async def` handling to docs. PR #61. +* Add [technical details about `async def` handling to docs](https://fastapi.tiangolo.com/async/#very-technical-details). PR [#61](https://github.com/tiangolo/fastapi/pull/61). -* Add docs for Debugging FastAPI applications in editors. +* Add docs for [Debugging FastAPI applications in editors](https://fastapi.tiangolo.com/tutorial/debugging/). -* Clarify Bigger Applications deployed with Docker. +* Clarify [Bigger Applications deployed with Docker](https://fastapi.tiangolo.com/deployment/#bigger-applications). * Fix typos in docs. -* Add section about History, Design and Future. +* Add section about [History, Design and Future](https://fastapi.tiangolo.com/history-design-future/). -* Add docs for using WebSockets with **FastAPI**. PR #62. +* Add docs for using [WebSockets with **FastAPI**](https://fastapi.tiangolo.com/tutorial/websockets/). PR [#62](https://github.com/tiangolo/fastapi/pull/62). ## 0.6.3 -* Add Favicons to docs. PR #53. +* Add Favicons to docs. PR [#53](https://github.com/tiangolo/fastapi/pull/53). ## 0.6.2 -* Introduce new project generator based on FastAPI and PostgreSQL: https://github.com/tiangolo/full-stack-fastapi-postgresql. PR #52. +* Introduce new project generator based on FastAPI and PostgreSQL: [https://github.com/tiangolo/full-stack-fastapi-postgresql](https://github.com/tiangolo/full-stack-fastapi-postgresql). PR [#52](https://github.com/tiangolo/fastapi/pull/52). -* Update SQL tutorial with SQLAlchemy, using `Depends` to improve editor support and reduce code repetition. PR #52. +* Update [SQL tutorial with SQLAlchemy, using `Depends` to improve editor support and reduce code repetition](https://fastapi.tiangolo.com/tutorial/sql-databases/). PR [#52](https://github.com/tiangolo/fastapi/pull/52). -* Improve middleware naming in tutorial for SQL with SQLAlchemy https://fastapi.tiangolo.com/tutorial/sql-databases/. +* Improve middleware naming in tutorial for SQL with SQLAlchemy [https://fastapi.tiangolo.com/tutorial/sql-databases/](https://fastapi.tiangolo.com/tutorial/sql-databases/). ## 0.6.1 -* Add docs for GraphQL: https://fastapi.tiangolo.com/tutorial/graphql/. PR #48. +* Add docs for GraphQL: [https://fastapi.tiangolo.com/tutorial/graphql/](https://fastapi.tiangolo.com/tutorial/graphql/). PR [#48](https://github.com/tiangolo/fastapi/pull/48). ## 0.6.0 -* Update SQL with SQLAlchemy tutorial at https://fastapi.tiangolo.com/tutorial/sql-databases/ using the new official `request.state`. PR #45. +* Update SQL with SQLAlchemy tutorial at [https://fastapi.tiangolo.com/tutorial/sql-databases/](https://fastapi.tiangolo.com/tutorial/sql-databases/) using the new official `request.state`. PR [#45](https://github.com/tiangolo/fastapi/pull/45). -* Upgrade Starlette to version `0.11.1` and add required compatibility changes. PR #44. +* Upgrade Starlette to version `0.11.1` and add required compatibility changes. PR [#44](https://github.com/tiangolo/fastapi/pull/44). ## 0.5.1 -* Add section about helping and getting help with **FastAPI**. +* Add section about [helping and getting help with **FastAPI**](https://fastapi.tiangolo.com/help-fastapi/). -* Add note about path operations order in docs. +* Add note about [path operations order in docs](https://fastapi.tiangolo.com/tutorial/path-params/#order-matters). -* Update section about error handling with more information and make relation with Starlette error handling utilities more explicit. PR #41. +* Update [section about error handling](https://fastapi.tiangolo.com/tutorial/handling-errors/) with more information and make relation with Starlette error handling utilities more explicit. PR [#41](https://github.com/tiangolo/fastapi/pull/41). -* Add Development - Contributing section to the docs. PR #42. +* Add Development - Contributing section to the docs. PR [#42](https://github.com/tiangolo/fastapi/pull/42). ## 0.5.0 -* Add new `HTTPException` with support for custom headers. With new documentation for handling errors at: https://fastapi.tiangolo.com/tutorial/handling-errors/. PR #35. +* Add new `HTTPException` with support for custom headers. With new documentation for handling errors at: [https://fastapi.tiangolo.com/tutorial/handling-errors/](https://fastapi.tiangolo.com/tutorial/handling-errors/). PR [#35](https://github.com/tiangolo/fastapi/pull/35). -* Add documentation to use Starlette `Request` object directly. Check #25 by @euri10. +* Add [documentation to use Starlette `Request` object](https://fastapi.tiangolo.com/tutorial/using-request-directly/) directly. Check [#25](https://github.com/tiangolo/fastapi/pull/25) by [@euri10](https://github.com/euri10). -* Add issue templates to simplify reporting bugs, getting help, etc: #34. +* Add issue templates to simplify reporting bugs, getting help, etc: [#34](https://github.com/tiangolo/fastapi/pull/34). -* Update example for the SQLAlchemy tutorial at https://fastapi.tiangolo.com/tutorial/sql-databases/ using middleware and database session attached to request. +* Update example for the SQLAlchemy tutorial at [https://fastapi.tiangolo.com/tutorial/sql-databases/](https://fastapi.tiangolo.com/tutorial/sql-databases/) using middleware and database session attached to request. ## 0.4.0 -* Add `openapi_prefix`, support for reverse proxy and mounting sub-applications. See the docs at https://fastapi.tiangolo.com/tutorial/sub-applications-proxy/: #26 by @kabirkhan. +* Add `openapi_prefix`, support for reverse proxy and mounting sub-applications. See the docs at [https://fastapi.tiangolo.com/tutorial/sub-applications-proxy/](https://fastapi.tiangolo.com/tutorial/sub-applications-proxy/): [#26](https://github.com/tiangolo/fastapi/pull/26) by [@kabirkhan](https://github.com/kabirkhan). -* Update docs/tutorial for SQLAlchemy including note about *DB Browser for SQLite*. +* Update [docs/tutorial for SQLAlchemy](https://fastapi.tiangolo.com/tutorial/sql-databases/) including note about _DB Browser for SQLite_. ## 0.3.0 -* Fix/add SQLAlchemy support, including ORM, and update docs for SQLAlchemy: #30. +* Fix/add SQLAlchemy support, including ORM, and update [docs for SQLAlchemy](https://fastapi.tiangolo.com/tutorial/sql-databases/): [#30](https://github.com/tiangolo/fastapi/pull/30). ## 0.2.1 -* Fix `jsonable_encoder` for Pydantic models with `Config` but without `json_encoders`: #29. +* Fix `jsonable_encoder` for Pydantic models with `Config` but without `json_encoders`: [#29](https://github.com/tiangolo/fastapi/pull/29). ## 0.2.0 -* Fix typos in Security section: #24 by @kkinder. +* Fix typos in Security section: [#24](https://github.com/tiangolo/fastapi/pull/24) by [@kkinder](https://github.com/kkinder). -* Add support for Pydantic custom JSON encoders: #21 by @euri10. +* Add support for Pydantic custom JSON encoders: [#21](https://github.com/tiangolo/fastapi/pull/21) by [@euri10](https://github.com/euri10). ## 0.1.19 -* Upgrade Starlette version to the current latest `0.10.1`: #17 by @euri10. +* Upgrade Starlette version to the current latest `0.10.1`: [#17](https://github.com/tiangolo/fastapi/pull/17) by [@euri10](https://github.com/euri10). diff --git a/scripts/deploy.sh b/scripts/deploy.sh index 6ad5606f6..3ed050af3 100755 --- a/scripts/deploy.sh +++ b/scripts/deploy.sh @@ -5,3 +5,5 @@ set -e bash scripts/publish.sh bash scripts/trigger-docker.sh + +python scripts/gitter_releases_bot.py diff --git a/scripts/gitter_releases_bot.py b/scripts/gitter_releases_bot.py new file mode 100644 index 000000000..b22e4c580 --- /dev/null +++ b/scripts/gitter_releases_bot.py @@ -0,0 +1,67 @@ +import inspect +import os + +import requests + +room_id = "5c9c9540d73408ce4fbc1403" # FastAPI +room_id = "5cc46398d73408ce4fbed233" # Gitter development + +gitter_token = os.getenv("GITTER_TOKEN") +assert gitter_token +github_token = os.getenv("GITHUB_TOKEN") +assert github_token +tag_name = os.getenv("TRAVIS_TAG") +assert tag_name + + +def get_github_graphql(tag_name: str): + github_graphql = """ + { + repository(owner: "tiangolo", name: "fastapi") { + release (tagName: "{{tag_name}}" ) { + description + } + } + } + """ + github_graphql = github_graphql.replace("{{tag_name}}", tag_name) + return github_graphql + + +def get_github_release_text(tag_name: str): + url = "https://api.github.com/graphql" + headers = {"Authorization": f"Bearer {github_token}"} + github_graphql = get_github_graphql(tag_name=tag_name) + response = requests.post(url, json={"query": github_graphql}, headers=headers) + assert response.status_code == 200 + data = response.json() + return data["data"]["repository"]["release"]["description"] + + +def get_gitter_message(release_text: str): + text = f""" + New release! :tada: :rocket: + (by FastAPI bot) + + ## {tag_name} + """ + text = inspect.cleandoc(text) + "\n\n" + release_text + return text + + +def send_gitter_message(text: str): + headers = {"Authorization": f"Bearer {gitter_token}"} + url = f"https://api.gitter.im/v1/rooms/{room_id}/chatMessages" + data = {"text": text} + response = requests.post(url, headers=headers, json=data) + assert response.status_code == 200 + + +def main(): + release_text = get_github_release_text(tag_name=tag_name) + text = get_gitter_message(release_text=release_text) + send_gitter_message(text=text) + + +if __name__ == "__main__": + main() diff --git a/scripts/rename_tutorial_src_files.py b/scripts/rename_tutorial_src_files.py deleted file mode 100644 index f1185654d..000000000 --- a/scripts/rename_tutorial_src_files.py +++ /dev/null @@ -1,34 +0,0 @@ -#%% -from pathlib import Path, PurePath -from string import digits - -directory = Path("./docs/src") -skip_names = {"bigger_applications"} -skip_dirs = {directory / name for name in skip_names} -dirs = sorted([Path(f) for f in directory.iterdir() if f not in skip_dirs]) -d: PurePath -sufix = "__out__" -for d in dirs: - if d.name.endswith(sufix): - continue - output_dir_name = d.name + "__out__" - output_directory = directory / output_dir_name - output_directory.mkdir(exist_ok=True) - files = sorted([Path(f) for f in d.iterdir()]) - f: PurePath - for i, f in enumerate(files): - index = str(i + 1).zfill(3) - if f.name != "__init__.py" and f.name.endswith(".py"): - new_name = output_directory / f"tutorial{index}.py" - else: - new_name = output_directory / f.name - print(new_name) - f.rename(new_name) - -for d in dirs: - current_dir = Path(str(d) + sufix) - print(current_dir) - current_dir.rename(d) - - -#%%