fill readme;

sumaro2101 · sumaro2101 · commit d91dc5d27c1b · 2024-12-16T01:42:48.000+06:00
diff --git a/README.md b/README.md
@@ -142,6 +142,12 @@ docker compose up
 В данный момент отправка осуществляется через `консоль`.
 Для деталей смотрите миксин `api_v1/users/mixins/ActionUserManagerMixin`
 
+### UserManager
+
+UserManager Это специальная обвертка для `SQLAlchemyUserDatabase` который в свою
+очередь вмещает в себя класс модели `User` и сессию `AsyncSession`
+Смотрите класс `api_v1/users/user_manager/UserManager`
+
 ### Transport
 
 В fastapi-users есть 2 вида транспорта:
@@ -189,7 +195,7 @@ def get_jwt_strategy() -> JWTStrategy:
 ### Backend
 
 auth_backend собирает `Transport` и `Strategy` воединно в `AuthenticationBackend`
-Этот класс необхим будет для:
+Этот класс необходим будет для:
 
 - `Authenticator`
 - `FastAPIUsers`
@@ -238,6 +244,7 @@ async def get_user(user: User = Depends(active_user)) -> User:
 FastAPIUsers применяется в итоговом выводе End-points в API
 
 ```python
+from fastapi import APIRouter
 from fastapi_users import FastAPIUsers
 
 from api_v1.auth.schemas import UserRead, UserUpdate
@@ -258,6 +265,26 @@ router.include_router(fastapi_users.get_users_router(UserRead, UserUpdate),
 
 По итогу будет добавлены новые End-points в API
 
+### Permissions
+
+С помощью Authenticator возможно осуществлять права доступа к End-points
+`api_v1/auth/permissions.py` содержит несколько `Callback` функции для permissions
+По желанию вы можете подолнять их.
+
+```python
+from fastapi import APIRouter
+
+from api_v1.auth import active_user
+
+
+router = APIRouter()
+
+
+@router.get(path='/get-user')
+async def get_user(user: User = Depends(active_user)) -> User:
+    return user
+```
+
 ## Найболее используемые
 
 Найболее используемые конструкции с которыми приходится часто взаимодействовать.
@@ -364,6 +391,23 @@ def register_middlewares(app: FastAPI) -> None:
 
 - При появлении новых middleware добавляйте их по порядку в эту функцию
 
+### DAO
+
+DAO необходим для CRUD manager любой модели.
+`config.dao.base_dao.BaseDAO`
+
+Для опеределения DAO вашей модели нужно наследовать `BaseDAO`, а Затем
+переопределить поле класса `model`
+
+```python
+from config.dao import BaseDAO
+from config.models import Product
+
+
+class ProductDAO(BaseDAO):
+    model = Product
+```
+
 ### Celery
 
 - Для регистрации task вам нужно создать файл с именем **tasks.py** в вашем приложении:
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -101,122 +101,122 @@ services:
       - POSTGRES_DB=${TEST_POSTGRES_DB}
       - POSTGRES_PASSWORD=${TEST_POSTGRES_PASSWORD}
 
-  # prometheus:
-  #   image: prom/prometheus
-  #   container_name: prometheus
-  #   volumes:
-  #     - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
-  #     - prometheus-data:/prometheus
-  #   command:
-  #     - '--config.file=/etc/prometheus/prometheus.yml'
-  #     - '--storage.tsdb.path=/prometheus'
-  #     - '--web.console.libraries=/etc/prometheus/console_libraries'
-  #     - '--web.console.templates=/etc/prometheus/consoles'
-  #     - '--storage.tsdb.retention.time=200h'
-  #     - '--web.enable-lifecycle'
-  #   restart: unless-stopped
-  #   expose:
-  #     - 9090
-  #   networks:
-  #     - monitor-net
-  #   labels:
-  #     org.label-schema.group: "monitoring"
+  prometheus:
+    image: prom/prometheus
+    container_name: prometheus
+    volumes:
+      - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
+      - prometheus-data:/prometheus
+    command:
+      - '--config.file=/etc/prometheus/prometheus.yml'
+      - '--storage.tsdb.path=/prometheus'
+      - '--web.console.libraries=/etc/prometheus/console_libraries'
+      - '--web.console.templates=/etc/prometheus/consoles'
+      - '--storage.tsdb.retention.time=200h'
+      - '--web.enable-lifecycle'
+    restart: unless-stopped
+    expose:
+      - 9090
+    networks:
+      - monitor-net
+    labels:
+      org.label-schema.group: "monitoring"
 
-  # alertmanager:
-  #   image: prom/alertmanager:v0.20.0
-  #   container_name: alertmanager
-  #   volumes:
-  #     - ./alertmanager:/etc/alertmanager
-  #   command:
-  #     - '--config.file=/etc/alertmanager/config.yml'
-  #     - '--storage.path=/alertmanager'
-  #   restart: unless-stopped
-  #   expose:
-  #     - 9093
-  #   networks:
-  #     - monitor-net
-  #   labels:
-  #     org.label-schema.group: "monitoring"
+  alertmanager:
+    image: prom/alertmanager:v0.20.0
+    container_name: alertmanager
+    volumes:
+      - ./alertmanager:/etc/alertmanager
+    command:
+      - '--config.file=/etc/alertmanager/config.yml'
+      - '--storage.path=/alertmanager'
+    restart: unless-stopped
+    expose:
+      - 9093
+    networks:
+      - monitor-net
+    labels:
+      org.label-schema.group: "monitoring"
 
-  # grafana:
-  #   image: grafana/grafana
-  #   container_name: grafana
-  #   volumes:
-  #     - grafana-data:/var/lib/grafana
-  #     - ./grafana/provisioning:/etc/grafana/provisioning
-  #   environment:
-  #     - DATABASE_USER=${DB_USER}
-  #     - DATABASE_PASS=${DB_PASSWORD}
-  #     - DATABASE_NAME=${DB_NAME}
-  #     - DATABASE_HOST=${DB_HOST}
-  #     - DATABASE_SSL_MODE=disable
-  #     - GF_USERS_ALLOW_SIGN_UP=false
-  #     - GF_SECURITY_ADMIN_USER=${GF_SECURITY_ADMIN_USER}
-  #     - GF_SECURITY_ADMIN_PASSWORD=${GF_SECURITY_ADMIN_PASSWORD}
-  #   restart: unless-stopped
-  #   expose:
-  #     - 3000
-  #   networks:
-  #     - monitor-net
-  #   labels:
-  #     org.label-schema.group: "monitoring"
+  grafana:
+    image: grafana/grafana
+    container_name: grafana
+    volumes:
+      - grafana-data:/var/lib/grafana
+      - ./grafana/provisioning:/etc/grafana/provisioning
+    environment:
+      - DATABASE_USER=${DB_USER}
+      - DATABASE_PASS=${DB_PASSWORD}
+      - DATABASE_NAME=${DB_NAME}
+      - DATABASE_HOST=${DB_HOST}
+      - DATABASE_SSL_MODE=disable
+      - GF_USERS_ALLOW_SIGN_UP=false
+      - GF_SECURITY_ADMIN_USER=${GF_SECURITY_ADMIN_USER}
+      - GF_SECURITY_ADMIN_PASSWORD=${GF_SECURITY_ADMIN_PASSWORD}
+    restart: unless-stopped
+    expose:
+      - 3000
+    networks:
+      - monitor-net
+    labels:
+      org.label-schema.group: "monitoring"
 
-  # nodeexporter:
-  #   image: prom/node-exporter:v0.18.1
-  #   container_name: nodeexporter
-  #   volumes:
-  #     - /proc:/host/proc:ro
-  #     - /sys:/host/sys:ro
-  #     - /:/rootfs:ro
-  #   command:
-  #     - '--path.procfs=/host/proc'
-  #     - '--path.rootfs=/rootfs'
-  #     - '--path.sysfs=/host/sys'
-  #     - '--collector.filesystem.ignored-mount-points=^/(sys|proc|dev|host|etc)($$|/)'
-  #   restart: unless-stopped
-  #   expose:
-  #     - 9100
-  #   networks:
-  #     - monitor-net
-  #   labels:
-  #     org.label-schema.group: "monitoring"
+  nodeexporter:
+    image: prom/node-exporter:v0.18.1
+    container_name: nodeexporter
+    volumes:
+      - /proc:/host/proc:ro
+      - /sys:/host/sys:ro
+      - /:/rootfs:ro
+    command:
+      - '--path.procfs=/host/proc'
+      - '--path.rootfs=/rootfs'
+      - '--path.sysfs=/host/sys'
+      - '--collector.filesystem.ignored-mount-points=^/(sys|proc|dev|host|etc)($$|/)'
+    restart: unless-stopped
+    expose:
+      - 9100
+    networks:
+      - monitor-net
+    labels:
+      org.label-schema.group: "monitoring"
 
-  # pushgateway:
-  #   image: prom/pushgateway:v1.2.0
-  #   container_name: pushgateway
-  #   restart: unless-stopped
-  #   expose:
-  #     - 9091
-  #   networks:
-  #     - monitor-net
-  #   labels:
-  #     org.label-schema.group: "monitoring"
+  pushgateway:
+    image: prom/pushgateway:v1.2.0
+    container_name: pushgateway
+    restart: unless-stopped
+    expose:
+      - 9091
+    networks:
+      - monitor-net
+    labels:
+      org.label-schema.group: "monitoring"
 
-  # caddy:
-  #   image: stefanprodan/caddy
-  #   container_name: caddy
-  #   ports:
-  #     - "3000:3000"
-  #     - "9090:9090"
-  #     - "9093:9093"
-  #     - "9091:9091"
-  #   volumes:
-  #     - ./caddy:/etc/caddy
-  #   environment:
-  #     - ADMIN_USER=${ADMIN_USER}
-  #     - ADMIN_PASSWORD=${ADMIN_PASSWORD}
-  #   restart: unless-stopped
-  #   networks:
-  #     - monitor-net
-  #   labels:
-  #     org.label-schema.group: "monitoring"
+  caddy:
+    image: stefanprodan/caddy
+    container_name: caddy
+    ports:
+      - "3000:3000"
+      - "9090:9090"
+      - "9093:9093"
+      - "9091:9091"
+    volumes:
+      - ./caddy:/etc/caddy
+    environment:
+      - ADMIN_USER=${ADMIN_USER}
+      - ADMIN_PASSWORD=${ADMIN_PASSWORD}
+    restart: unless-stopped
+    networks:
+      - monitor-net
+    labels:
+      org.label-schema.group: "monitoring"
 
 volumes:
   postgres_data:
   test_postgres_data:
   rabbitmq-data:
-  # prometheus-data: {}
-  # grafana-data: {}
+  prometheus-data: {}
+  grafana-data: {}
 
 networks:
   monitor-net:
