MNV · Samoed · Feb 23, 2023 · Mar 5, 2023 · Mar 5, 2023 · Mar 5, 2023
diff --git a/Dockerfile b/Dockerfile
@@ -16,7 +16,7 @@ RUN apt-get update && apt-get install -y \
     && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
     && apt-get clean -y && rm -rf /var/lib/apt/lists/*
 
-COPY ./requirements.txt ./setup.cfg ./black.toml ./.pylintrc /
+COPY ./requirements.txt ./setup.cfg ./black.toml ./.pylintrc ./pytest.ini /
 
 RUN --mount=type=cache,target=/root/.cache/pip \
     pip install --upgrade pip -r /requirements.txt

diff --git a/Makefile b/Makefile
@@ -20,5 +20,11 @@ lint:
 test:
 	docker compose run favorite-places-app pytest --cov=/src --cov-report html:htmlcov --cov-report term --cov-config=/src/tests/.coveragerc -vv
 
+database:
+	docker compose up -d favorite-places-db
+
+migrate:
+	docker compose run favorite-places-app alembic upgrade head
+
 # запуск всех функций поддержки качества кода
 all: format lint test
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/img/2023-03-05_00-01.png b/docs/img/2023-03-05_00-01.png
diff --git a/docs/img/2023-03-05_13-31.png b/docs/img/2023-03-05_13-31.png
diff --git a/...hot 2023-03-05 at 00-00-01 API системы Favorite Places Service - Swagger UI.png b/...hot 2023-03-05 at 00-00-01 API системы Favorite Places Service - Swagger UI.png
diff --git a/...hot 2023-03-05 at 00-01-14 API системы Favorite Places Service - Swagger UI.png b/...hot 2023-03-05 at 00-01-14 API системы Favorite Places Service - Swagger UI.png
diff --git a/docs/img/pagination.png b/docs/img/pagination.png
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -23,7 +23,7 @@
 version = settings.project.release_version
 # the full project version, including alpha/beta/rc tags
 release = settings.project.release_version
-author = "Michael"
+author = "Roman"
 copyright = f"{date.today().year}, {author}"
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,11 +6,56 @@
 Зависимости
 ===========
 
+Install the appropriate software:
+
+1. [Docker Desktop](https://www.docker.com).
+2. [Git](https://github.com/git-guides/install-git).
+3. [PyCharm](https://www.jetbrains.com/ru-ru/pycharm/download) (optional).
 
 
 Установка
 =========
 
+Clone the repository to your computer:
+
+.. code-block::console
+
+    git clone https://github.com/mnv/python-course-favorite-places.git
+
+1. To configure the application copy `.env.sample` into `.env` file:
+
+    .. code-block::console
+
+        cp .env.sample .env
+
+
+    This file contains environment variables that will share their values across the application.
+    The sample file (`.env.sample`) contains a set of variables with default values.
+    So it can be configured depending on the environment.
+
+2. Build the container using Docker Compose:
+
+    .. code-block::console
+
+     docker compose build
+
+    This command should be run from the root directory where `Dockerfile` is located.
+    You also need to build the docker container again in case if you have updated `requirements.txt`.
+
+3. To run application correctly set up the database.
+   Apply migrations to create tables in the database:
+
+    .. code-block::console
+
+        docker compose run favorite-places-app alembic upgrade head
+
+4. Now it is possible to run the project inside the Docker container:
+
+    .. code-block::console
+
+        docker compose up
+
+   When containers are up server starts at [http://0.0.0.0:8010/docs](http://0.0.0.0:8010/docs). You can open it in your browser.
 
 
 Использование
@@ -20,15 +65,155 @@
 
 Работа с базой данных
 ---------------------
+To first initialize migration functionality run:
+
+    .. code-block::console
+
+        docker compose exec favorite-places-app alembic init -t async migrations
+
+This command will create a directory with configuration files to set up asynchronous migrations' functionality.
+
+To create new migrations that will update database tables according updated models run this command:
+
+    .. code-block::console
 
+        docker compose run favorite-places-app alembic revision --autogenerate  -m "your description"
+
+To apply created migrations run:
+
+    .. code-block::console
+
+        docker compose run favorite-places-app alembic upgrade head
 
 
 Автоматизация
 =============
+The project contains a special `Makefile` that provides shortcuts for a set of commands:
+
+1. Build the Docker container:
+
+.. code-block::console
+
+    make build
+
+
+2. Generate Sphinx documentation run:
+
+    .. code-block::console
+
+        make docs-html
+
+
+3. Autoformat source code:
+
+    .. code-block::console
+
+        make format
+
+
+4. Static analysis (linters):
+
+    .. code-block::console
+
+        make lint
+
+
+5. Autotests:
+
+    .. code-block::console
+
+        make test
+
+
+    The test coverage report will be located at `src/htmlcov/index.html`.
+    So you can estimate the quality of automated test coverage.
+
+6. Run autoformat, linters and tests in one command:
+
+    .. code-block::console
+
+        make all
+
+
+    Run these commands from the source directory where `Makefile` is located.
 
 
 
 Тестирование
 ============
+To run tests use the following command:
 
+    .. code-block::console
 
+        make all
+
+Документация
+============
+
+Клиенты
+=======
+Базовый
+--------
+.. automodule:: clients.base.base
+    :members:
+
+Geo
+---
+.. automodule:: clients.geo
+    :members:
+
+Schemas
+-------
+.. automodule:: clients.base.base
+    :members:
+
+Integrations
+============
+Database
+--------
+.. automodule:: integrations.db.session
+    :members:
+Events
+------
+.. automodule:: integrations.events.events
+    :members:
+.. automodule:: integrations.events.schemas
+    :members:
+
+Models
+======
+.. automodule:: models.mixins
+    :members:
+.. automodule:: models.places
+    :members:
+Repositories
+============
+.. automodule:: repositories.base_repository
+    :members:
+.. automodule:: repositories.places_repository
+    :members:
+
+
+Settings
+========
+.. automodule:: settings
+    :members:
+
+Schemas
+=======
+.. automodule:: schemas.base
+    :members:
+.. automodule:: schemas.places
+    :members:
+.. automodule:: schemas.routes
+    :members:
+
+Services
+========
+.. automodule:: services.places_service
+    :members:
+
+Transport
+=========
+.. automodule:: transport.handlers.places
+    :members:
diff --git a/report.md b/report.md
@@ -0,0 +1,31 @@
+
+# Table of Contents
+
+1.  [Определение по ip](#org33cd135)
+2.  [Пагинация](#org395fab9)
+3.  [Результаты `make all`](#orgd4362b8)
+
+
+
+<a id="org33cd135"></a>
+
+# Определение по ip
+
+![img](docs/img/Screenshot 2023-03-05 at 00-01-14 API системы Favorite Places Service - Swagger UI.png)
+![img](docs/img/Screenshot 2023-03-05 at 00-00-01 API системы Favorite Places Service - Swagger UI.png)
+![img](docs/img/2023-03-05_00-01.png)
+
+
+<a id="org395fab9"></a>
+
+# Пагинация
+
+![img](docs/img/pagination.png)
+
+
+<a id="orgd4362b8"></a>
+
+# Результаты `make all`
+
+![img](docs/img/2023-03-05_13-31.png)
+
diff --git a/report.org b/report.org
@@ -0,0 +1,11 @@
+#+title: Report
+
+* Определение по ip
+[[file:docs/img/Screenshot 2023-03-05 at 00-01-14 API системы Favorite Places Service - Swagger UI.png]]
+[[file:docs/img/Screenshot 2023-03-05 at 00-00-01 API системы Favorite Places Service - Swagger UI.png]]
+[[file:docs/img/2023-03-05_00-01.png]]
+
+* Пагинация
+[[file:docs/img/pagination.png]]
+* Результаты =make all=
+[[file:docs/img/2023-03-05_13-31.png]]
diff --git a/requirements.txt b/requirements.txt
@@ -16,6 +16,8 @@ asyncpg>=0.26.0,<1.0.0
 pika>=1.3.1,<1.4.0
 # работа с HTTP-запросами
 httpx>=0.23.0,<0.24.0
+sqlalchemy-utils==0.40.0
+psycopg2-binary==2.9.5
 
 # автоматические тесты
 pytest>=7.1.3,<7.2.0

diff --git a/src/__init__.py b/src/__init__.py
diff --git a/src/alembic.ini b/src/alembic.ini
diff --git a/src/bootstrap.py b/src/bootstrap.py
@@ -1,4 +1,5 @@
 from fastapi import FastAPI
+from fastapi_pagination import add_pagination
 
 from exceptions import setup_exception_handlers
 from routes import metadata_tags, setup_routes
@@ -19,5 +20,6 @@ def build_app() -> FastAPI:
 
     setup_routes(app)
     setup_exception_handlers(app)
+    add_pagination(app)
 
     return app
diff --git a/src/clients/__init__.py b/src/clients/__init__.py
diff --git a/src/clients/base/__init__.py b/src/clients/base/__init__.py
diff --git a/src/clients/base/base.py b/src/clients/base/base.py
diff --git a/src/clients/geo.py b/src/clients/geo.py
@@ -8,7 +8,7 @@
 import httpx
 
 from clients.base.base import BaseClient
-from clients.shemas import LocalityDTO
+from clients.schemas import LocalityDTO
 
 
 class LocationClient(BaseClient):

diff --git a/src/clients/shemas.py → src/clients/schemas.py b/src/clients/shemas.py → src/clients/schemas.py
diff --git a/src/exceptions.py b/src/exceptions.py
@@ -11,7 +11,7 @@ class ApiHTTPException(HTTPException):
     """Обработка ошибок API."""
 
     status_code: int
-    code: str
+    code: str = "None"
     detail: str
 
     def __init__(

diff --git a/src/integrations/__init__.py b/src/integrations/__init__.py
diff --git a/src/integrations/db/__init__.py b/src/integrations/db/__init__.py
diff --git a/src/integrations/db/session.py b/src/integrations/db/session.py
diff --git a/src/integrations/events/__init__.py b/src/integrations/events/__init__.py
diff --git a/src/integrations/events/producer.py b/src/integrations/events/producer.py
diff --git a/src/integrations/events/schemas.py b/src/integrations/events/schemas.py
diff --git a/src/logging.conf b/src/logging.conf
@@ -1,6 +1,7 @@
 [loggers]
 keys=root
 
+
 [handlers]
 keys=fileHandler
 
@@ -15,7 +16,7 @@ handlers=fileHandler
 class=FileHandler
 level=DEBUG
 formatter=commonFormatter
-args=('/logs/actions.log', 'a',)
+args=('../logs/actions.log', 'a',)
 
 [formatter_commonFormatter]
 format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
diff --git a/src/main.py b/src/main.py
diff --git a/src/migrations/README b/src/migrations/README
diff --git a/src/migrations/env.py b/src/migrations/env.py
diff --git a/src/migrations/script.py.mako b/src/migrations/script.py.mako
diff --git a/src/migrations/versions/9e96afce0c9e_init.py b/src/migrations/versions/9e96afce0c9e_init.py
diff --git a/src/models/__init__.py b/src/models/__init__.py
diff --git a/src/models/mixins.py b/src/models/mixins.py
diff --git a/src/models/places.py b/src/models/places.py
diff --git a/src/repositories/__init__.py b/src/repositories/__init__.py
diff --git a/src/repositories/base_repository.py b/src/repositories/base_repository.py
diff --git a/src/repositories/places_repository.py b/src/repositories/places_repository.py
diff --git a/src/routes.py b/src/routes.py
diff --git a/src/schemas/__init__.py b/src/schemas/__init__.py
diff --git a/src/schemas/base.py b/src/schemas/base.py
diff --git a/src/schemas/places.py b/src/schemas/places.py
diff --git a/src/schemas/routes.py b/src/schemas/routes.py
@@ -1,6 +1,6 @@
 from typing import Optional
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 
 class MetadataTag(BaseModel):
@@ -11,3 +11,9 @@ class MetadataTag(BaseModel):
 
     class Config:
         allow_population_by_field_name = True
+
+
+class Description(BaseModel):
+    """Модель для описания"""
+
+    description: str = Field(None, min_length=3, max_length=255)
diff --git a/src/services/__init__.py b/src/services/__init__.py