{"id":18249005,"url":"https://github.com/samplec0de/lyrics-ide-backend","last_synced_at":"2025-04-08T19:56:09.838Z","repository":{"id":235278259,"uuid":"738115543","full_name":"samplec0de/lyrics-ide-backend","owner":"samplec0de","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-30T21:32:48.000Z","size":6137,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-14T15:49:47.863Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://lyrics-backend.k8s-1.sslane.ru/docs","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/samplec0de.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-01-02T13:10:27.000Z","updated_at":"2024-09-30T21:32:43.000Z","dependencies_parsed_at":"2024-04-22T23:24:44.244Z","dependency_job_id":"982ac090-e56f-40a2-b52e-f491f845b243","html_url":"https://github.com/samplec0de/lyrics-ide-backend","commit_stats":null,"previous_names":["samplec0de/lyrics-ide-backend"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samplec0de%2Flyrics-ide-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samplec0de%2Flyrics-ide-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samplec0de%2Flyrics-ide-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samplec0de%2Flyrics-ide-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samplec0de","download_url":"https://codeload.github.com/samplec0de/lyrics-ide-backend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247918927,"owners_count":21018044,"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","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":[],"created_at":"2024-11-05T09:38:55.879Z","updated_at":"2025-04-08T19:56:09.802Z","avatar_url":"https://github.com/samplec0de.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/lyrics-ide-backend.png\" width=\"60%\" alt=\"project-logo\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ch1 align=\"center\"\u003eLYRICS-IDE-BACKEND\u003c/h1\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003cem\u003eВеб-приложение для разработки текстов песен. Серверная часть.\u003c/em\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"https://img.shields.io/github/license/samplec0de/lyrics-ide-backend?style=flat\u0026logo=opensourceinitiative\u0026logoColor=white\u0026color=0080ff\" alt=\"license\"\u003e\n\t\u003cimg src=\"https://img.shields.io/github/last-commit/samplec0de/lyrics-ide-backend?style=flat\u0026logo=git\u0026logoColor=white\u0026color=0080ff\" alt=\"last-commit\"\u003e\n\t\u003cimg src=\"https://img.shields.io/github/languages/top/samplec0de/lyrics-ide-backend?style=flat\u0026color=0080ff\" alt=\"repo-top-language\"\u003e\n\u003cp\u003e\n\u003cp align=\"center\"\u003e\n\t\t\u003cem\u003eРазработано с использованием технологий\u003c/em\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/Pydantic-E92063.svg?style=flat\u0026logo=Pydantic\u0026logoColor=white\" alt=\"Pydantic\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/YAML-CB171E.svg?style=flat\u0026logo=YAML\u0026logoColor=white\" alt=\"YAML\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/OpenAI-412991.svg?style=flat\u0026logo=OpenAI\u0026logoColor=white\" alt=\"OpenAI\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/Python-3776AB.svg?style=flat\u0026logo=Python\u0026logoColor=white\" alt=\"Python\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/AIOHTTP-2C5BB4.svg?style=flat\u0026logo=AIOHTTP\u0026logoColor=white\" alt=\"AIOHTTP\"\u003e\n\t\u003cbr\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/Docker-2496ED.svg?style=flat\u0026logo=Docker\u0026logoColor=white\" alt=\"Docker\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style=flat\u0026logo=GitHub-Actions\u0026logoColor=white\" alt=\"GitHub%20Actions\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/NumPy-013243.svg?style=flat\u0026logo=NumPy\u0026logoColor=white\" alt=\"NumPy\"\u003e\n\t\u003cimg src=\"https://img.shields.io/badge/FastAPI-009688.svg?style=flat\u0026logo=FastAPI\u0026logoColor=white\" alt=\"FastAPI\"\u003e\n\u003c/p\u003e\n\n# 📖 Содержание\n- [📍 Описание](#-описание)\n- [🧩 Ключевые особенности](#-ключевые-особенности)\n- [🗂️ Структура репозитория](#-структура-репозитория)\n- [🚀 Начало работы](#-начало-работы)\n  - [⚙️ Установка](#-установка)\n  - [🤖 Запуск](#-запуск)\n  - [🧪 Тесты](#-тесты)\n- [🎗 Лицензия](#-лицензия)\n- [🔗 Сторонние зависимости](#-сторонние-зависимости)\n\u003chr\u003e\n\n## 📍 Описание\n\nРепозиторий содержит серверную часть веб-приложения (API), разработанную для платформы разработки текстов песен.\n\nОсновные функции\n- Аутентификация и авторизация пользователей\n- Управление проектами и текстами\n- Загрузка музыкальных файлов и определение BPM (beats per minute)\n- Автодополнение текстов песен с использованием искусственного интеллекта\n- Определение значения слов, получение синонимов, поиск рифм\n\nКлючевым принципом бэкенда является интеграция передовых веб-платформ \nи технологий для обеспечения высокой производительности и надежности.\nВ проекте используется Docker для инкапсуляции среды, что делает развертывание последовательным и эффективным.\nKubernetes используется для управления контейнерами и обеспечения масштабируемости.\n\nКачество кода имеет первостепенное значение, оно обеспечивается с помощью различных корректировок и проверок стиля, \nс помощью библиотек указанных в `requirements.linters.txt`.\nТестирование - еще один важный аспект. Используются библиотеки для асинхронного тестирования, мокирования и составления \nотчетов о покрытии - `requirements.tests.txt`.\nБлагодаря тестам и статическому анализу кода обеспечивается соответствие серверной части стандартам качества.\n\nПроект предлагает мощную платформу для творчества - написания текстов, дополненную технологической строгостью, \nчто делает ее ценным инструментом для артистов, стремящихся использовать современные технологии для оптимизации своей работы.\n\n---\n\n## 🧩 Ключевые особенности\n\n|    | Особенность            | Описание                                                                                                                     |\n|----|------------------------|------------------------------------------------------------------------------------------------------------------------------|\n| ⚙️  | **Архитектура**        | stateless модульный монолит на основе FastAPI, использует Docker для контейнеризации                                         |\n| 🔩 | **Качество кода**      | Применяются линтеры6 форматтеры для проверки стиля                                                                           |\n| 📄 | **Документация**       | Обширная документация в файлах и комментариях в модулях, описывающих функциональность. Swagger UI, ReDoc поставляются с API. |\n| 🔌 | **Интеграции**         | Интеграция с AI-сервисом - OpenAI, библиотека мультимедиа -  aubio, технологии Яндекса (Яндекс Словарь).                     |\n| 🧩 | **Модульность**        | Высокая модульность с четким разделением функциональности.                                                                   |\n| 🧪 | **Тесты**              | Быстрые асинхронные модульные и интеграционные тесты в CI/CD.                                                                |\n| ⚡️  | **Производительность** | Используется асинхронное программирование для повышения производительности.                                                  |\n| 🛡️ | **Безопасность**       | Используется `python-jose` для обработки JWT, обеспечивая безопасную обработку данных.                                       |\n| 🚀 | **Масштабируемость**   | Используется kubernetes для управления масштабированием.                                                                     |\n\n---\n\n## 🗂️ Структура репозитория\n\n```sh\n└── lyrics-ide-backend/\n    ├── .github\n    │   └── workflows\n    │       └── deploy-prod.yml\n    ├── CHANGELOG.md\n    ├── Dockerfile\n    ├── README.md\n    ├── app\n    │   ├── alembic\n    │   │   └── versions\n    │   ├── api\n    │   │   ├── routers\n    │   ├── main.py\n    │   ├── models\n    ├── docs\n    ├── k8s\n    ├── requirements.linters.txt\n    ├── requirements.tests.txt\n    ├── requirements.txt\n    └── tests\n        ├── integration_tests\n        └── unit_tests\n```\n\n---\n\n## 🚀 Начало работы\n\n**Требования:**\n\n* TODO\n\n### ⚙️ Установка\n\n\u003ch4\u003eFrom \u003ccode\u003esource\u003c/code\u003e\u003c/h4\u003e\n\n\u003e 1. Склонируйте репозиторий lyrics-ide-backend:\n\u003e\n\u003e ```console\n\u003e $ git clone https://github.com/samplec0de/lyrics-ide-backend\n\u003e ```\n\u003e\n\u003e 2. Перейдите в директорию проекта:\n\u003e ```console\n\u003e $ cd lyrics-ide-backend\n\u003e ```\n\u003e\n\u003e 3. Установите зависимости:\n\u003e ```console\n\u003e $ pip install -r requirements.txt\n\u003e ```\n\u003e \n\u003eTODO\n\n### 🤖 Запуск\n\n\u003ch4\u003eFrom \u003ccode\u003esource\u003c/code\u003e\u003c/h4\u003e\n\n\u003e Запустите приложение:\n\u003e ```console\n\u003e $ python main.py\n\u003e ```\n\n### 🧪 Тесты\n\n\u003e Запустите тесты:\n\u003e ```console\n\u003e $ pytest tests/integration_tests\n\u003e $ pytest tests/unit_tests\n\u003e ```\n\n---\n\n## 🎗 Лицензия\n\nПроект защищен [SELECT-A-LICENSE](https://choosealicense.com/licenses). Подробности смотрите на [LICENSE](https://choosealicense.com/licenses/).\n\n---\n\n## 🔗 Сторонние зависимости\n\n- TODO\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamplec0de%2Flyrics-ide-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamplec0de%2Flyrics-ide-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamplec0de%2Flyrics-ide-backend/lists"}