{"id":21887187,"url":"https://github.com/profcomff/userdata-api","last_synced_at":"2025-10-24T20:11:10.661Z","repository":{"id":153581462,"uuid":"621887647","full_name":"profcomff/userdata-api","owner":"profcomff","description":"Серверная часть сервиса хранения и управления информации о пользователе","archived":false,"fork":false,"pushed_at":"2025-03-26T17:45:07.000Z","size":83,"stargazers_count":13,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T18:38:06.866Z","etag":null,"topics":["auth-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}},"created_at":"2023-03-31T15:49:10.000Z","updated_at":"2024-12-08T09:33:31.000Z","dependencies_parsed_at":"2024-04-05T22:27:49.572Z","dependency_job_id":"452f7fb2-5009-4cd9-ad96-c292869bab1a","html_url":"https://github.com/profcomff/userdata-api","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fuserdata-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fuserdata-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fuserdata-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fuserdata-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/profcomff","download_url":"https://codeload.github.com/profcomff/userdata-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249048711,"owners_count":21204305,"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":["auth-service"],"created_at":"2024-11-28T11:08:43.817Z","updated_at":"2025-10-24T20:11:10.584Z","avatar_url":"https://github.com/profcomff.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Сервис пользовательских данных\n\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/userdata-api.git\u0026param.Working+directory=userdata-api)\n\n![Auth Schema](https://github.com/profcomff/auth-api/assets/5656720/ab2730be-054a-454c-ab76-5475e615bb64)\n\n## Функционал\n1. Управление категориями, параметрами, источниками данных.\n2. Управление правами доступа к информации\n3. Получение/изменение пользовательской информации через HTTP\n4. Потоковое изменение пользовательской информации на основе данных передаваемых OAuth методами входа\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    foo@bar:~$ pip install -r requirements.txt\n    foo@bar:~$ pip install -r requirements.dev.txt\n    ```\n4. Запускайте приложение!\n    ```console\n    foo@bar:~$ python -m userdata_api start --instance api -- запустит АПИ\n    foo@bar:~$ python -m userdata_api start --instance worker -- запустит Kafka worker\n    ```\n\nПриложение состоит из двух частей - АПИ и Kafka worker'а.\n\nАПИ нужно для управления структурой пользовательских данных -\nконтроль над категориями данных, параметрами, источниками данных.\nТакже, в АПИ пользовательские данные может слать\nсам пользователь(владелец этих данных), а также админ\n\nKafka worker нужен для того, чтобы разгребать поступающие от OAuth\nметодов авторизации AuthAPI пользовательские данные\n\n## ENV-variables description\n\n:star2: Все параметры для Kafka являются необязательными\n\n- `DB_DSN=postgresql://postgres@localhost:5432/postgres` – Данные для подключения к БД\n- `KAFKA_DSN` - URL для подключение к Kafka\n- `KAFKA_LOGIN` - логин для подключения к Kafka\n- `KAFKA_PASSWORD` - пароль для подключения к Kafka\n- `KAFKA_TOPICS` - Kafka топики, из которых читается информация\n- `KAFKA_GROUP_ID` - Группа, от имени которой происходит чтение топиков\n- Остальные общие для всех АПИ параметры описаны [тут](https://docs.profcomff.com/tvoy-ff/backend/settings.html)\n\n## Основные абстракции\n\n- Параметр - поле для пользовательской информации(например: Email, Телефон, Адрес, Курс обучения, Номер студенческого билета)\n\n- Категория - объединение нескольких параметров по общему признаку. Например: Email, Телефон - _личная информация_; Курс обучения, Номер студенческого билета - _учеба_. Категория имеет `read_scope` - право на её чтение другими пользователями и `update_scope` - право на её изменение дургими пользователями\n\n- Источник - откуда пришла информация о пользователе. Наприимер: VK, GitHub, LKMSU, User(он сам её добавил), Admin(админ её добавил). Источник имеет `trust_level`: то есть информации из одних источников мы можем доверять больше, чем другим\n\n- Информация - само значение поля. Имеет ссылку на параметр и источник. Соответственно, значение одного параметра у пользователя может быть списком, так как информация для этого параметра пришла из различных источников\n\n### Пример\n\nПользователь с `id=1`\n\n| Категория  |  Параметр | Источник  |  Значение |\n|---|---|---|---|\n| Учёба  | Курс обучения  |  User | 4  |\n| Учёба  | Курс обучения  | LKMSU  | 4  |\n| Учёба  |  Номер студенческого билета | LKMSU  |  42424242 |\n| Личная информация  | Email  |  User | email1@real.email  |\n| Личная информация  | Email  | Admin  | email2@real.email  |\n| Личная информация  |  Email | VK  |  email3@vk.real.email |\n| Личная информация  | Email  |  Yandex | email4@ya.real.email  |\n| Личная информация  | Email  | GitHub  | email5@github.email  |\n| Личная информация  |  Телефон | User  |  +79094242 |\n\n\n## Сценарий использования\n\n### Создать категорию\n\n1. Дёрнуть ручку `POST /category`. Вы передаете\n```json\n{\n  \"name\": \"\", // Имя категории\n  \"read_scope\": \"\", // Скоуп на чтение\n  \"update_scope\": \"\" // Скоуп на запись\n}\n```\n2. Сооздать в Auth API нужные scopes(если передали не `null`)\n\n### Создать параметр\n\n1. Дернуть ручку `POST /category/{category_id}/param`. Передать\n```json\n{\n  \"name\": \"\", // Имя параметра\n  \"is_required\": bool, // Обязателен ли он\n  \"changeable\": bool, // Изменяем ли он после установки\n  \"type\": \"all || last || most_trusted\" // Какой значение параметра из множества, задаваемого источником, будет возвращаться\n}\n```\n\n### Получить список категорий\n\n1. Дернуть ручку `GET /category`. Если нужна иинформация о параметрах, которые есть в каждой из категорий, то дернуть ручку `GET /category?query=param`\n\n### Обновить информацию о пользователе\n\n1. Дернуть ручку `POST /user/{user_id}`, передать туда\n```json\n{\n  \"items\": [ // Список новых значений\n    {\n      \"category\": \"\", // Имя категории в которой находится параметр\n      \"param\": \"\", // Имя изменяемого параметра\n      \"value\": \"\" // Новое значение. Если раньше значения не существовало, то оно будет создано. Если передать null, то значение будет удалено.\n    }\n  ],\n  \"source\": \"string\" // Источник информации. По http доступно только user и admin\n}\n```\n- Информацию меняется только в пределах источника. То есть админ не может поменять инфоормацию, переданную пользователем. Он может только создать новую или поменять информацию из источника admin\n\n- Пользователь может создать любую информацию о себе\n\n- Пользователь может обновить/удалить только _изменяемую_ информацию\n\n- Неизменяемая информация изменяема при наличии scope `userdata.info.update`\n\n- Обновить информацию о другом пользователе из конкретноой категории можно только при наличии права на изменение в этой категории (см. `category.update_scope`)\n\n### Получить информацию о пользователе/пользователях\n\n#### Получить информацию о пользователе по id\n\nДернуть ручку `GET /user/{user_id}`.\n\n- Пользователь может получить всю информацию о себе\n\n#### Получить информацию о нескольких пользователях об указанных категориях\n\nДернуть ручку `GET /user?users=...?categories=...`. \n\n- Ручка закрыта за скоупом `userdata.info.admin`\n\n- Query параметры `users` и `categories` обязательные\n\nВ обеих `GET /user/` ручках информация будет возвращаться таким образом:\n\n- В соответствии с переданными scopes\n- Можно получить только информацию из тех категорий на которые у него есть права (см `category.read_scope`)\n- С поставленными `param.type`.\n\n  - Если поставлен `all` то вернется информация соотв. данному параметру из всех источников\n  - `last` - вернется последняя обновленная информация\n  - `most_trusted` - вернется информация из самого доверенного источника\n\n## Contributing\n\n- Основная [информация](https://docs.profcomff.com/tvoy-ff/backend/index.html) по разработке наших приложений\n\n- [Ссылка](https://github.com/profcomff/userdata-api/blob/main/CONTRIBUTING.md) на страницу с информацией по разработке userdata-api\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofcomff%2Fuserdata-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprofcomff%2Fuserdata-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofcomff%2Fuserdata-api/lists"}