https://github.com/code-418-dpr/vzor-cv

Модуль CV для проекта VZOR
https://github.com/code-418-dpr/vzor-cv

cv docker hackathon-project microservices sports-programming vzor

Last synced: 10 months ago
JSON representation

Модуль CV для проекта VZOR

• Host: GitHub
• URL: https://github.com/code-418-dpr/vzor-cv
• Owner: code-418-dpr
• License: mit
• Created: 2025-03-06T18:07:26.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-29T18:15:54.000Z (11 months ago)
• Last Synced: 2025-07-07T19:51:45.812Z (11 months ago)
• Topics: cv, docker, hackathon-project, microservices, sports-programming, vzor
• Language: Python
• Homepage:
• Size: 231 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# VZOR-cv

[![license](https://img.shields.io/github/license/code-418-dpr/VZOR-cv)](https://opensource.org/licenses/MIT)

[![release](https://img.shields.io/github/v/release/code-418-dpr/VZOR-cv?include_prereleases)](https://github.com/code-418-dpr/VZOR-cv/releases)

[![downloads](https://img.shields.io/github/downloads/code-418-dpr/VZOR-cv/total)](https://github.com/code-418-dpr/VZOR-cv/releases)

[![code size](https://img.shields.io/github/languages/code-size/code-418-dpr/VZOR-cv.svg)](https://github.com/code-418-dpr/VZOR-cv)

[![Linter](https://github.com/code-418-dpr/VZOR-cv/actions/workflows/linter.yaml/badge.svg)](https://github.com/code-418-dpr/VZOR-cv/actions/workflows/linter.yaml)

[![Docker](https://github.com/code-418-dpr/VZOR-cv/actions/workflows/docker.yaml/badge.svg)](https://github.com/code-418-dpr/VZOR-cv/actions/workflows/docker.yaml)

[![CodeQL (Python, GH Actions)](https://github.com/code-418-dpr/VZOR-cv/actions/workflows/codeql.yaml/badge.svg)](https://github.com/code-418-dpr/VZOR-cv/actions/workflows/codeql.yaml)

Сервис распознавания изображений для проекта [VZOR](https://github.com/code-418-dpr/VZOR)

## Стек

-   **Python** — язык программирования

-   **uv** — самый быстрый пакетный менеджер для Python

-   **gRPC** — фреймворк для связи сервиса с [основным бэкендом](https://github.com/code-418-dpr/VZOR-backend)

-   **BLIP Image Captioning Large** — модель для описания изображений

-   **YOLO** — модель для классификации изображений

-   **EasyOCR** — модель для распознавания текста на изображениях

-   **Ruff** — быстрый линтер с большим количеством правил

-   **Docker** — платформа для контейнеризации

## Установка и запуск

0. Клонируйте репозиторий и перейдите в его папку.

### Посредством Docker

1. Установите Docker.

2. Создайте файл `.env` на основе [.env.template](.env.template) и настройте все описанные там параметры.

3. Запустите сборку образа:

```shell

docker build -t vzor-cv .

```

4. Теперь запускать образ можно командой:

```shell

docker run -d -p 50051:50051 --name vzor-cv-standalone vzor-cv

```

### Без использования Docker

1. Установите пакетный менеджер uv одним из способов. Например, для Windows:

```shell

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

```

2. Установите зависимости:

```shell

uv sync --frozen --no-dev

```

3. Создайте файл `.env` на основе [.env.template](.env.template) и настройте все описанные там параметры.

4. Теперь запускать сервер gRPC можно командой:

```shell

uv run -m src

```

Чтобы протестировать работу сервиса, параллельно с запуском gRPC-сервера можно запустить тестовый клиент:

```shell

uv run -m src.grpc.test_client

```

## Модификация

Если вы планируете модифицировать проект, установите все зависимости:

```shell

uv sync

```

Запустить линтинг кода (и автоисправление некоторых ошибок) можно через Ruff:

```shell

uv run ruff check --fix .

```