{"id":28437064,"url":"https://github.com/chrnmaxim/fts_fastapi","last_synced_at":"2025-06-27T20:31:57.301Z","repository":{"id":297398733,"uuid":"996109668","full_name":"chrnmaxim/fts_fastapi","owner":"chrnmaxim","description":"Реализация FTS (FastAPI + SQLAlchemy + PostgreSQL)","archived":false,"fork":false,"pushed_at":"2025-06-05T08:27:13.000Z","size":90,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-05T09:29:22.023Z","etag":null,"topics":["fastapi","fts","postgresql","sqlalchemy"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrnmaxim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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}},"created_at":"2025-06-04T13:21:21.000Z","updated_at":"2025-06-05T08:29:12.000Z","dependencies_parsed_at":"2025-06-05T09:41:26.897Z","dependency_job_id":null,"html_url":"https://github.com/chrnmaxim/fts_fastapi","commit_stats":null,"previous_names":["chrnmaxim/fts_fastapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/chrnmaxim/fts_fastapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrnmaxim%2Ffts_fastapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrnmaxim%2Ffts_fastapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrnmaxim%2Ffts_fastapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrnmaxim%2Ffts_fastapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrnmaxim","download_url":"https://codeload.github.com/chrnmaxim/fts_fastapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrnmaxim%2Ffts_fastapi/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262327258,"owners_count":23294238,"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":["fastapi","fts","postgresql","sqlalchemy"],"created_at":"2025-06-05T23:08:35.953Z","updated_at":"2025-06-27T20:31:57.289Z","avatar_url":"https://github.com/chrnmaxim.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FTS FastAPI\n## Реализация полнотекстового поиска (FastAPI + SQLAlchemy + PostgreSQL)\n\n[![Static Badge](https://img.shields.io/badge/python-3670A0?style=for-the-badge\u0026logo=python\u0026logoColor=ffdd54)](https://www.python.org)\n[![Static Badge](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge\u0026logo=fastapi)](https://fastapi.tiangolo.com/)\n[![Static Badge](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge\u0026logo=swagger\u0026logoColor=white)](https://swagger.io)\n[![Static Badge](https://img.shields.io/badge/postgresql-4169e1?style=for-the-badge\u0026logo=postgresql\u0026logoColor=white)](https://www.postgresql.org)\n[![Static Badge](https://img.shields.io/badge/-SQLAlchemy-ffd54?style=for-the-badge\u0026logo=sqlalchemy\u0026logoColor=white)](https://www.sqlalchemy.org/)\n[![Static Badge](https://img.shields.io/badge/docker-257bd6?style=for-the-badge\u0026logo=docker\u0026logoColor=white)](https://www.docker.com/)\n\n\n## О проекте\nПроект предназначен для реализации полнотекстового поиска в PostgresSQL c использованием FastAPI и SQLAlchemy.\n\nВ качестве примера в проекте создаётся таблица `posts` с постами различных категорий.\nПолнотекстовый поиск реализован за счёт создания индекса на поле `search_vector` типа `TSVECTOR`, значение которого обновляется при добавлении записи в таблицу `posts` или обновлении текста в поле `content` у существующей записи с помощью триггера на стороне БД.\n\n\u003e [!NOTE]\n\u003e При обновлении вектора и последующем поиске учитывается язык текста постов. По умолчанию установлен `russian` в `src/.env.example`. При необходимости можно установить другой язык, поддерживаемый [PostgreSQL](https://www.postgresql.org/docs/current/textsearch-psql.html).\n\n## Установка и запуск проекта\n\n1. Установить [uv](https://docs.astral.sh/uv/getting-started/installation/).\n\n2. Клонировать проект:\n```bash\ngit clone git@github.com:chrnmaxim/fts_fastapi.git\n```\n\n3. Перейти в корневую директорию проекта.\n\n4. Установить зависимости, включая зависимости для разработки:\n\n```bash\nuv sync --extra dev\n```\n\n5. Создать `.env` на основании `.env.example`:\n\n```bash\ncp -r src/.env.example src/.env\n```\n\n6. Запустить API и PostgreSQL в Docker контейнерах:\n```bash\nmake start_dev\n```\n\n7. Применить миграции:\n```bash\ndocker compose exec fts_fastapi alembic upgrade heads\n```\n\n8. Документация API и доступные эндпоинт:\n* Swagger UI: http://127.0.0.1:8000/docs\n* ReDoc: http://127.0.0.1:8000/redoc\n\n9. Для остановки контейнеров выполнить\n```bash\nmake stop_dev\n```\n\n## Тесты\n1. Перед запуском тестов необходимо создать `.env.test` на основе`.env.test.example`:\n```bash\ncp -r src/.env.test.example src/.env.test\n```\n\n2. Тесты запускаются из независимой базы данных Postgres с помощью команды `make test`.\n\n3. После выполнения тестов в файле `htmlcov/index.html` можно увидеть отчет о покрытии кода тестами.\n\n\u003e [!NOTE]\n\u003e Тесты запускаются в GitHub Actions с каждым коммитом в открытом Pull Request в ветку `develop` или `main`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrnmaxim%2Ffts_fastapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrnmaxim%2Ffts_fastapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrnmaxim%2Ffts_fastapi/lists"}