From 49ab43e9cdadf0153781f03e669d1122112b47f4 Mon Sep 17 00:00:00 2001 From: emp7yhead Date: Sat, 4 Jun 2022 20:32:12 +0900 Subject: [PATCH 1/5] Add: original file in docs/ru/docs/deployment --- docs/ru/docs/deployment/versions.md | 87 +++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 docs/ru/docs/deployment/versions.md diff --git a/docs/ru/docs/deployment/versions.md b/docs/ru/docs/deployment/versions.md new file mode 100644 index 0000000000000..4be9385ddf530 --- /dev/null +++ b/docs/ru/docs/deployment/versions.md @@ -0,0 +1,87 @@ +# About FastAPI versions + +**FastAPI** is already being used in production in many applications and systems. And the test coverage is kept at 100%. But its development is still moving quickly. + +New features are added frequently, bugs are fixed regularly, and the code is still continuously improving. + +That's why the current versions are still `0.x.x`, this reflects that each version could potentially have breaking changes. This follows the Semantic Versioning conventions. + +You can create production applications with **FastAPI** right now (and you have probably been doing it for some time), you just have to make sure that you use a version that works correctly with the rest of your code. + +## Pin your `fastapi` version + +The first thing you should do is to "pin" the version of **FastAPI** you are using to the specific latest version that you know works correctly for your application. + +For example, let's say you are using version `0.45.0` in your app. + +If you use a `requirements.txt` file you could specify the version with: + +```txt +fastapi==0.45.0 +``` + +that would mean that you would use exactly the version `0.45.0`. + +Or you could also pin it with: + +```txt +fastapi>=0.45.0,<0.46.0 +``` + +that would mean that you would use the versions `0.45.0` or above, but less than `0.46.0`, for example, a version `0.45.2` would still be accepted. + +If you use any other tool to manage your installations, like Poetry, Pipenv, or others, they all have a way that you can use to define specific versions for your packages. + +## Available versions + +You can see the available versions (e.g. to check what is the current latest) in the [Release Notes](../release-notes.md){.internal-link target=_blank}. + +## About versions + +Following the Semantic Versioning conventions, any version below `1.0.0` could potentially add breaking changes. + +FastAPI also follows the convention that any "PATCH" version change is for bug fixes and non-breaking changes. + +!!! tip + The "PATCH" is the last number, for example, in `0.2.3`, the PATCH version is `3`. + +So, you should be able to pin to a version like: + +```txt +fastapi>=0.45.0,<0.46.0 +``` + +Breaking changes and new features are added in "MINOR" versions. + +!!! tip + The "MINOR" is the number in the middle, for example, in `0.2.3`, the MINOR version is `2`. + +## Upgrading the FastAPI versions + +You should add tests for your app. + +With **FastAPI** it's very easy (thanks to Starlette), check the docs: [Testing](../tutorial/testing.md){.internal-link target=_blank} + +After you have tests, then you can upgrade the **FastAPI** version to a more recent one, and make sure that all your code is working correctly by running your tests. + +If everything is working, or after you make the necessary changes, and all your tests are passing, then you can pin your `fastapi` to that new recent version. + +## About Starlette + +You shouldn't pin the version of `starlette`. + +Different versions of **FastAPI** will use a specific newer version of Starlette. + +So, you can just let **FastAPI** use the correct Starlette version. + +## About Pydantic + +Pydantic includes the tests for **FastAPI** with its own tests, so new versions of Pydantic (above `1.0.0`) are always compatible with FastAPI. + +You can pin Pydantic to any version above `1.0.0` that works for you and below `2.0.0`. + +For example: + +```txt +pydantic>=1.2.0,<2.0.0 +``` From cc41b8267977a31c24187f37c6e808534b1d87fb Mon Sep 17 00:00:00 2001 From: emp7yhead Date: Sun, 5 Jun 2022 00:39:32 +0900 Subject: [PATCH 2/5] Add russian translation for versions.md --- docs/ru/docs/deployment/versions.md | 70 ++++++++++++++--------------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/ru/docs/deployment/versions.md b/docs/ru/docs/deployment/versions.md index 4be9385ddf530..0ca0758448822 100644 --- a/docs/ru/docs/deployment/versions.md +++ b/docs/ru/docs/deployment/versions.md @@ -1,86 +1,86 @@ -# About FastAPI versions +# О версиях FastAPI -**FastAPI** is already being used in production in many applications and systems. And the test coverage is kept at 100%. But its development is still moving quickly. +**FastAPI** уже используется в продакшене во многих приложениях и системах. Покрытие тестами поддерживается на уровне 100%. Однако, его разработка все еще продолжается. -New features are added frequently, bugs are fixed regularly, and the code is still continuously improving. +Часто добавляются новые функции, регулярно исправляются баги, код продолжает постоянно совершенствоваться. -That's why the current versions are still `0.x.x`, this reflects that each version could potentially have breaking changes. This follows the Semantic Versioning conventions. +По указанным причинам текущие версии до сих пор `0.x.x`. Это говорит о том, что каждая версия может содержать обратно несовместимые изменения, следуя соглашению о Семантическом Версионировании. -You can create production applications with **FastAPI** right now (and you have probably been doing it for some time), you just have to make sure that you use a version that works correctly with the rest of your code. +Уже сейчас вы можете создавать приложения в продакшене, используя **FastAPI** (и скорее всего так и делаете), главное убедиться в том, что вы используете версию, которая корректно работает с вашим кодом. -## Pin your `fastapi` version +## Закрепите вашу версию `fastapi` -The first thing you should do is to "pin" the version of **FastAPI** you are using to the specific latest version that you know works correctly for your application. +Первым делом вам следует "закрепить" конкретную последнюю используемую версию **FastAPI**, которая корректно работает с вашим приложением. -For example, let's say you are using version `0.45.0` in your app. +Например, вы используете версию `0.45.0` в приложении. -If you use a `requirements.txt` file you could specify the version with: +Если вы используете файл `requirements.txt`, вы можете указать версию следующим способом: ```txt fastapi==0.45.0 ``` -that would mean that you would use exactly the version `0.45.0`. +что значит, что вы будете использовать именно версию `0.45.0`. -Or you could also pin it with: +Или вы можете закрепить версию следующим способом: ```txt fastapi>=0.45.0,<0.46.0 ``` -that would mean that you would use the versions `0.45.0` or above, but less than `0.46.0`, for example, a version `0.45.2` would still be accepted. +что значит, что вы используете версии `0.45.0` или выше, но меньше чем `0.46.0`. Например, версия `0.45.2` все еще будет подходить. -If you use any other tool to manage your installations, like Poetry, Pipenv, or others, they all have a way that you can use to define specific versions for your packages. +Если вы используете любой другой инструмент для организации установки, например Poetry, Pipenv или др., у них у всех имеется способ определения специфической версии для ваших пакетов. -## Available versions +## Доступные версии -You can see the available versions (e.g. to check what is the current latest) in the [Release Notes](../release-notes.md){.internal-link target=_blank}. +Вы можете увидеть доступные версии (например - проверить последнюю на данный момент) в [Release Notes](../release-notes.md){.internal-link target=_blank}. -## About versions +## О версиях -Following the Semantic Versioning conventions, any version below `1.0.0` could potentially add breaking changes. +Следуя соглашению о Семантическом Версионировании, любые версии ниже `1.0.0` потенциально могут добавить обратно несовместимые изменения. -FastAPI also follows the convention that any "PATCH" version change is for bug fixes and non-breaking changes. +FastAPI следует соглашению в том, что любые изменения "ПАТЧ"-версии предназначены для исправления багов и обратно совместимых изменений. !!! tip - The "PATCH" is the last number, for example, in `0.2.3`, the PATCH version is `3`. + "ПАТЧ" - это последнее число. Например, в `0.2.3`, ПАТЧ-версия - это `3`. -So, you should be able to pin to a version like: +Итак, вы можете закрепить версию следующим образом: ```txt fastapi>=0.45.0,<0.46.0 ``` -Breaking changes and new features are added in "MINOR" versions. +Обратно несовместимые изменения и новые функции добавляются в "МИНОРНЫЕ" версии. !!! tip - The "MINOR" is the number in the middle, for example, in `0.2.3`, the MINOR version is `2`. + "МИНОРНАЯ" версия - это число в середине. Например, в `0.2.3` МИНОРНАЯ версия - это `2`. -## Upgrading the FastAPI versions +## Обновление версии FastAPI -You should add tests for your app. +Вам следует добавить тесты для вашего приложения. -With **FastAPI** it's very easy (thanks to Starlette), check the docs: [Testing](../tutorial/testing.md){.internal-link target=_blank} +С помощью **FastAPI** это очень просто (благодаря Starlette), см. документацию: [Testing](../tutorial/testing.md){.internal-link target=_blank} -After you have tests, then you can upgrade the **FastAPI** version to a more recent one, and make sure that all your code is working correctly by running your tests. +После создания тестов вы можете обновить свою версию **FastAPI** до более новой. После это следует убедиться, что ваш код работает корректно, запустив тесты. -If everything is working, or after you make the necessary changes, and all your tests are passing, then you can pin your `fastapi` to that new recent version. +Если все работает корректно или после внесения необходимых изменений все ваши тесты проходят, только тогда вы можете закрепить вашу новую версию `fastapi`. -## About Starlette +## О Starlette -You shouldn't pin the version of `starlette`. +Не следует закреплять версию `starlette`. -Different versions of **FastAPI** will use a specific newer version of Starlette. +Разные версии **FastAPI** будут использовать более новые версии Starlette. -So, you can just let **FastAPI** use the correct Starlette version. +Так что решение о используемой версии Starlette, вы можете оставить **FastAPI**. -## About Pydantic +## О Pydantic -Pydantic includes the tests for **FastAPI** with its own tests, so new versions of Pydantic (above `1.0.0`) are always compatible with FastAPI. +Pydantic включает свои собственные тесты для **FastAPI**, так что новые версии Pydantic (выше `1.0.0`) всегда совместимы с FastAPI. -You can pin Pydantic to any version above `1.0.0` that works for you and below `2.0.0`. +Вы можете закрепить любую версию Pydantic, которая вам подходит, выше `1.0.0` и ниже `2.0.0`. -For example: +Например: ```txt pydantic>=1.2.0,<2.0.0 From 8c9ee7aa59d8b045981f0c6c2f89d0ced13487b9 Mon Sep 17 00:00:00 2001 From: emp7yhead Date: Sun, 5 Jun 2022 00:50:31 +0900 Subject: [PATCH 3/5] Update mkdocs.yml --- docs/ru/mkdocs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/ru/mkdocs.yml b/docs/ru/mkdocs.yml index bb0702489da52..f5b125e4bb2d9 100644 --- a/docs/ru/mkdocs.yml +++ b/docs/ru/mkdocs.yml @@ -57,6 +57,8 @@ nav: - uk: /uk/ - zh: /zh/ - async.md +- Развёртывание: + - deployment/versions.md markdown_extensions: - toc: permalink: true From f184d09307c0a4094579750129ae1a2f72ac075c Mon Sep 17 00:00:00 2001 From: emp7yhead Date: Sat, 20 Aug 2022 14:40:02 +0900 Subject: [PATCH 4/5] Fix typo --- docs/ru/docs/deployment/versions.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/ru/docs/deployment/versions.md b/docs/ru/docs/deployment/versions.md index 0ca0758448822..4cdd7ddb157fc 100644 --- a/docs/ru/docs/deployment/versions.md +++ b/docs/ru/docs/deployment/versions.md @@ -1,6 +1,6 @@ # О версиях FastAPI -**FastAPI** уже используется в продакшене во многих приложениях и системах. Покрытие тестами поддерживается на уровне 100%. Однако, его разработка все еще продолжается. +**FastAPI** уже используется в продакшене во многих приложениях и системах. Покрытие тестами поддерживается на уровне 100%. Однако его разработка все еще продолжается. Часто добавляются новые функции, регулярно исправляются баги, код продолжает постоянно совершенствоваться. @@ -34,13 +34,13 @@ fastapi>=0.45.0,<0.46.0 ## Доступные версии -Вы можете увидеть доступные версии (например - проверить последнюю на данный момент) в [Release Notes](../release-notes.md){.internal-link target=_blank}. +Вы можете увидеть доступные версии (например, проверить последнюю на данный момент) в [Release Notes](../release-notes.md){.internal-link target=_blank}. ## О версиях Следуя соглашению о Семантическом Версионировании, любые версии ниже `1.0.0` потенциально могут добавить обратно несовместимые изменения. -FastAPI следует соглашению в том, что любые изменения "ПАТЧ"-версии предназначены для исправления багов и обратно совместимых изменений. +FastAPI следует соглашению в том, что любые изменения "ПАТЧ"-версии предназначены для исправления багов и внесения обратно совместимых изменений. !!! tip "ПАТЧ" - это последнее число. Например, в `0.2.3`, ПАТЧ-версия - это `3`. @@ -64,7 +64,7 @@ fastapi>=0.45.0,<0.46.0 После создания тестов вы можете обновить свою версию **FastAPI** до более новой. После это следует убедиться, что ваш код работает корректно, запустив тесты. -Если все работает корректно или после внесения необходимых изменений все ваши тесты проходят, только тогда вы можете закрепить вашу новую версию `fastapi`. +Если все работает корректно, или после внесения необходимых изменений все ваши тесты проходят, только тогда вы можете закрепить вашу новую версию `fastapi`. ## О Starlette @@ -72,7 +72,7 @@ fastapi>=0.45.0,<0.46.0 Разные версии **FastAPI** будут использовать более новые версии Starlette. -Так что решение о используемой версии Starlette, вы можете оставить **FastAPI**. +Так что решение об используемой версии Starlette, вы можете оставить **FastAPI**. ## О Pydantic From 9ff9f923558143df95db58d21b1891e68dd70035 Mon Sep 17 00:00:00 2001 From: emp7yhead Date: Wed, 24 Aug 2022 23:56:10 +0900 Subject: [PATCH 5/5] Fix typos --- docs/ru/docs/deployment/versions.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/ru/docs/deployment/versions.md b/docs/ru/docs/deployment/versions.md index 4cdd7ddb157fc..91b9038e9f3f2 100644 --- a/docs/ru/docs/deployment/versions.md +++ b/docs/ru/docs/deployment/versions.md @@ -12,7 +12,7 @@ Первым делом вам следует "закрепить" конкретную последнюю используемую версию **FastAPI**, которая корректно работает с вашим приложением. -Например, вы используете версию `0.45.0` в приложении. +Например, в своём приложении вы используете версию `0.45.0`. Если вы используете файл `requirements.txt`, вы можете указать версию следующим способом: @@ -20,7 +20,7 @@ fastapi==0.45.0 ``` -что значит, что вы будете использовать именно версию `0.45.0`. +это означает, что вы будете использовать именно версию `0.45.0`. Или вы можете закрепить версию следующим способом: @@ -28,13 +28,13 @@ fastapi==0.45.0 fastapi>=0.45.0,<0.46.0 ``` -что значит, что вы используете версии `0.45.0` или выше, но меньше чем `0.46.0`. Например, версия `0.45.2` все еще будет подходить. +это значит, что вы используете версии `0.45.0` или выше, но меньше чем `0.46.0`. Например, версия `0.45.2` все еще будет подходить. -Если вы используете любой другой инструмент для организации установки, например Poetry, Pipenv или др., у них у всех имеется способ определения специфической версии для ваших пакетов. +Если вы используете любой другой инструмент для управления зависимостями, например Poetry, Pipenv или др., у них у всех имеется способ определения специфической версии для ваших пакетов. ## Доступные версии -Вы можете увидеть доступные версии (например, проверить последнюю на данный момент) в [Release Notes](../release-notes.md){.internal-link target=_blank}. +Вы можете посмотреть доступные версии (например, проверить последнюю на данный момент) в [примечаниях к выпуску](../release-notes.md){.internal-link target=_blank}. ## О версиях @@ -42,7 +42,7 @@ fastapi>=0.45.0,<0.46.0 FastAPI следует соглашению в том, что любые изменения "ПАТЧ"-версии предназначены для исправления багов и внесения обратно совместимых изменений. -!!! tip +!!! Подсказка "ПАТЧ" - это последнее число. Например, в `0.2.3`, ПАТЧ-версия - это `3`. Итак, вы можете закрепить версию следующим образом: @@ -53,16 +53,16 @@ fastapi>=0.45.0,<0.46.0 Обратно несовместимые изменения и новые функции добавляются в "МИНОРНЫЕ" версии. -!!! tip +!!! Подсказка "МИНОРНАЯ" версия - это число в середине. Например, в `0.2.3` МИНОРНАЯ версия - это `2`. -## Обновление версии FastAPI +## Обновление версий FastAPI Вам следует добавить тесты для вашего приложения. -С помощью **FastAPI** это очень просто (благодаря Starlette), см. документацию: [Testing](../tutorial/testing.md){.internal-link target=_blank} +С помощью **FastAPI** это очень просто (благодаря Starlette), см. документацию: [Тестирование](../tutorial/testing.md){.internal-link target=_blank} -После создания тестов вы можете обновить свою версию **FastAPI** до более новой. После это следует убедиться, что ваш код работает корректно, запустив тесты. +После создания тестов вы можете обновить свою версию **FastAPI** до более новой. После этого следует убедиться, что ваш код работает корректно, запустив тесты. Если все работает корректно, или после внесения необходимых изменений все ваши тесты проходят, только тогда вы можете закрепить вашу новую версию `fastapi`.