{"id":21887198,"url":"https://github.com/profcomff/print-api","last_synced_at":"2025-10-11T10:13:59.367Z","repository":{"id":58467775,"uuid":"429472112","full_name":"profcomff/print-api","owner":"profcomff","description":"Серверная часть сервиса отправки заданий на печать и получения файлов для печати с терминала","archived":false,"fork":false,"pushed_at":"2025-10-01T19:14:12.000Z","size":1253,"stargazers_count":14,"open_issues_count":16,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-01T20:38:06.147Z","etag":null,"topics":["print-service"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/profcomff.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-11-18T15:00:48.000Z","updated_at":"2025-03-07T21:05:43.000Z","dependencies_parsed_at":"2023-11-28T17:27:56.532Z","dependency_job_id":"2c2832ec-145d-4c60-9575-72439a7ad121","html_url":"https://github.com/profcomff/print-api","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/profcomff/print-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fprint-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fprint-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fprint-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fprint-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/profcomff","download_url":"https://codeload.github.com/profcomff/print-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fprint-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279006838,"owners_count":26084203,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["print-service"],"created_at":"2024-11-28T11:08:45.958Z","updated_at":"2025-10-11T10:13:59.329Z","avatar_url":"https://github.com/profcomff.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Сервис печати\nСерверная часть сервиса для работы с документами, отправляемыми на печать\n\n[\u003cimg src=\"https://cdn.profcomff.com/easycode/easycode.svg\" width=\"200\"\u003e\u003c/img\u003e](https://easycode.profcomff.com/templates/docker-fastapi/workspace?mode=manual\u0026param.Repository+URL=https://github.com/profcomff/print-api.git\u0026param.Working+directory=print-api)\n\n## Функционал \n1. Управление файлами, отправляемыми пользователями на печать\n    - Создание/удаление файлов\n    - Редактирование параметров печати\n\n2. Получение файлов со стороны клиента-терминала печати \n\n3. Управление пользователями, которым разрешена печать на принтере\n\n4. Прямое подключение клиентом-терминалом печати \n    - Генерация QR кодов для быстрой печати\n    - Отправка команд на мгновенное обновление/перезагрузку терминала \n\n\n## Запуск\n\n1. Перейдите в папку проекта\n\n2. Создайте виртуальное окружение командой и активируйте его:\n    ```console\n    foo@bar:~$ python3 -m venv venv\n    foo@bar:~$ source ./venv/bin/activate  # На MacOS и Linux\n    foo@bar:~$ venv\\Scripts\\activate  # На Windows\n    ```\n\n3. Установите библиотеки\n    ```console\n    (venv) foo@bar:~$ pip install -r requirements.txt\n    (venv) foo@bar:~$ pip install -r requirements.dev.txt\n    ```\n\n4. Поднимите базу данных\n    ```console\n    (venv) foo@bar:~$ docker run -d -p 5432:5432 -e POSTGRES_HOST_AUTH_METHOD=trust --name db-print_service postgres:15\n    (venv) foo@bar:~$ alembic upgrade head  # Произвести миграции БД\n    ```\n\n5. Запускайте приложение!\n    ```console\n    (venv) foo@bar:~$ python -m print_service\n    ```\n\n\n## ENV-variables description\n\n- `DB_DSN=postgresql://postgres@localhost:5432/postgres` – Данные для подключения к БД\n- `STATIC_PATH` - путь до папки, в которой лежит статика.\n- `REDIS_DSN` - Данные для подключения к Redis\n- `CONTENT_TYPES` - типы принимаемого контента для печати\n- `MAX_SIZE` - Максимальный размер файла в байтах\n- `MAX_PAGE_COUNT` - Максимальное количество страниц для печати\n- `STORAGE_TIME` - Время хранения файла в часах\n- `ALLOW_STUDENT_NUMBER` - разрешить ли номер студенческого для печати\n- `PIN_SYMBOLS` - символы из которых состоит ПИН-код\n- `PIN_LENGTH` - длина пин-кода\n- `QR_TOKEN_PREFIX` - префикс QR кода\n- `QR_TOKEN_SYMBOLS` - символы из которых состоит QR-код\n- `QR_TOKEN_LENGTH` - Длина QR-кода\n- `QR_TOKEN_TTL` - время жизни QR-кода (время показа)\n- `QR_TOKEN_DELAY` - как долго QR-код будет валидным после того, как прошел TTL (исчез с экрана)\n- Остальные общие для всех АПИ параметры описаны [тут](https://docs.profcomff.com/tvoy-ff/backend/settings.html)\n\n## Основные абстракции\n- `Пользователь` - сущность, у которой есть номер студенческого и профсоюзного билета, а также фамилию\n- `Файл` - сущность, отвечающая за загруженный пользователем файл. Имеет пин-код для скачивания, ссылку на реальный файл (который лежит в static хранилище), а также опции печати и ссылку на пользователья, который его загрузил\n- `Факт печати` - сущность для статистики печати. Каждый раз, когда кто-то печатает файл, создается эта сущность со ссылкой на файл и его владельца, а также количеством использованных страниц\n\n## Сценарий использования\n1. Обновить список пользователей.\n\n    Дернуть ручку `POST /print/is_union_member`, передать json со списком новых пользователей:\n    ```json\n    {\n    \"users\": [\n        {\n        \"username\": \"string\",\n        \"union_number\": \"string\",\n        \"student_number\": \"string\"\n        }\n    ]\n    }\n    ```\n    Если пользователь с таким студенческим _или_ профсоюзным уже существует, то вся остальная информация будет заменена. Иначе, создается новый пользователь.\n\n2. Проверить, что пользователь существует в системе\n    Дернуть ручку `GET /print/is_union_member?surname=...\u0026number=...`, передать в query параметрах фамилию и номер профсоюзного билета.\n    Вернет ответ, найден ли пользователь.\n3. Загрузить файл\n\n    Дернуть ручку `POST /print/file`, передать туда json:\n    ```json\n    {\n    \"surname\": \"Иванов\",\n    \"number\": \"1015000\",\n    \"filename\": \"filename.pdf\",\n    \"source\": \"string\",\n    \"options\": {\n        \"pages\": \"\", // \"\" если распечатать надо все страницы, иначе формат такой: \"10-13,16,18,20,21,24,25,27,28,30\", можно не сортировать\n        \"copies\": 1,\n        \"two_sided\": false\n    }\n    }\n    ```\n    Передается пользователь с его проф. билетом.\n    Ручка вернет pin в таком формате:\n    ```json\n    {\n    \"pin\": \"OF72I1\",\n    \"options\": {\n        \"pages\": \"\",\n        \"copies\": 1,\n        \"two_sided\": false\n    }\n    }\n    ```\n    Его надо сохранить и отправить еще один запрос на загрузку самого файла:\n    Дернуть ручку `POST /print/file/{pin}`, передать файл в бинарном виде\n    Ручка вернет тот же json, что и предыдущая в случае успеха\n\n    После этого файл готов к печати\n\n4. Получить файл\n    Дернуть ручку `GET /print/file/{pin}`\n    Вернет json:\n    ```json\n    {\n    \"filename\": \"2021-11-02-ZMNF5V...9.pdf\",\n    \"options\": {\n        \"pages\": \"\",\n        \"copies\": 1,\n        \"two_sided\": false\n    }\n    }\n    ```\n    По ссылке можно скачать файл из static хранилища, options помогают распечтать файл, если запрос идет от принтера\n\n5. Как работает QR\n    Пользователь приходит к терминалу, считывает QR-код, после этого с его устройства идет запрос на `POST /qr`, в котором передается отсканированный QR-код и пин для печати\n\n    Терминал подключен к бэкенду через вебсокет. Бэкенд после получения запроса от пользователя в течение некоторого времени отправляет хапрос на печать файла.\n\n6. Ручное обновление и перезагрузка\n    Делается с админским токеном\n    Ручки, соответственно: `POST /admin/update` и `POST /admin/reboot`\n    Спецификация доступна в Swagger UI\n\n## Contributing\n\n- Основная [информация](https://docs.profcomff.com/tvoy-ff/backend/index.html) по разработке наших приложений\n\n- [Ссылка](https://github.com/profcomff/print-api/blob/main/CONTRIBUTING.md) на страницу с информацией по разработке print-api\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofcomff%2Fprint-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprofcomff%2Fprint-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofcomff%2Fprint-api/lists"}