{"id":21887208,"url":"https://github.com/profcomff/dwh-definitions","last_synced_at":"2025-12-24T10:31:41.216Z","repository":{"id":188739416,"uuid":"674323941","full_name":"profcomff/dwh-definitions","owner":"profcomff","description":"Data structures and migrations library","archived":false,"fork":false,"pushed_at":"2025-04-07T14:22:16.000Z","size":242,"stargazers_count":5,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T14:38:56.579Z","etag":null,"topics":["airflow","data-platform","dwh"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/profcomff-definitions/","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":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}},"created_at":"2023-08-03T17:00:34.000Z","updated_at":"2025-04-07T13:44:16.000Z","dependencies_parsed_at":"2024-04-06T14:23:39.588Z","dependency_job_id":"51b4acbb-73d7-4cc9-b475-c5d9ead7d5f4","html_url":"https://github.com/profcomff/dwh-definitions","commit_stats":null,"previous_names":["profcomff/dwh-definitions"],"tags_count":58,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fdwh-definitions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fdwh-definitions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fdwh-definitions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/profcomff%2Fdwh-definitions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/profcomff","download_url":"https://codeload.github.com/profcomff/dwh-definitions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249048713,"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":["airflow","data-platform","dwh"],"created_at":"2024-11-28T11:08:47.312Z","updated_at":"2025-12-24T10:31:41.210Z","avatar_url":"https://github.com/profcomff.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dwh-definitions\n\nБиблиотека, описывающая структуру всех баз данных профкома ФФ. Реализована с помощью разделения всех баз данных в 4 категории - [STG](https://github.com/profcomff/dwh-definitions/blob/main/profcomff_definitions/STG/README.md), [DWH](https://github.com/profcomff/dwh-definitions/blob/main/profcomff_definitions/DWH/README.md), [ODS](https://github.com/profcomff/dwh-definitions/blob/main/profcomff_definitions/ODS/README.md) и [DM](https://github.com/profcomff/dwh-definitions/blob/main/profcomff_definitions/DM/README.md).\n\n[\u003cimg src=\"https://cdn.profcomff.com/easycode/easycode.svg\" width=\"200\"\u003e\u003c/img\u003e](https://easycode.profcomff.com/templates/docker-airflow/workspace?mode=manual)\n\n## Функционал\n- Удобное и структурированное хранение данных\n- Разграничение и удобное управление правами доступа\n\n## Разработка\n- Backend разработка – https://github.com/profcomff/.github/wiki/%5Bdev%5D-Backend-разработка\n- Работа с данными -https://github.com/profcomff/.github/wiki/%5Bdev%5D-Работа-с-данными\n\n## Quick start\n1. Перейдите в папку проекта\n2. Создайте виртуальное окружение командой:\n```commandline\npython3 -m venv ./venv/\n```\n3. Установите библиотеки\n```commandline\npip install -U -r requirements.dev.txt -r requirements.txt\n```\n\n## Использование\nВ своих базах данных мы используем postgres базы данных. Для того чтобы использовать данный репозиторий необходимо сделать несколько предварительных шагов\n1. Проделай пункты из \"Как начать работу локально\" отсюда: https://github.com/profcomff/dwh-airflow\n2. Склонируй этот репозиторий на свой компьютер командой `git clone https://github.com/profcomff/dwh-definitions`\n3. Создай виртуальное окружение Python. Для этого нужно:\n    - Установить python3.11 (если еще не установлен): https://www.python.org/downloads/\n    - Установить pip (если еще не установлен, команда в консоли `python -m ensurepip --upgrade`)\n    - Создать в папке `dwh-definitions` новое виртуальное окружение python3.11 (команда в консоли `python3.11 -m venv venv` или `python -m venv venv`)\n    - Подключиться к этому виртуальному окружению (команда консоли на windows: `venv\\Scripts\\activate.bat`, на мак/линукс: `source venv/bin/activate`)\n    - Установить библиотеки командой `pip install -U -r requirements.dev.txt -r requirements.txt`\n\n    Теперь у тебя на компьютере есть база данных, Airflow, описание базы данных в виде питона\n\n4. Обнови схему базы данных командой `python3 -m definitions upgrade head`. Это создаст в базе данных все те же таблицы, что есть в production базе данных.\n\n5. После этого в папках из /ddl можно создавать свои схемы таблиц. Пример таблицы можно посмотреть в /ddl/STG/union_member.py\n\n\n### Дальнейшие шаги:\n\nРассмотрим дальнейшие действия на примере тестовой таблицы Test. Допустим, что она лежит в /ddl/STG/test_table.py\n\n1. Импортировать созданную таблицу в \\_\\_init__.py файл соответствующей папки. В нашем случае в /ddl/STG/\\_\\_init__.py необходимо дописать строчку:\n```python\nfrom .test_table import Test\n```\n2. В строчку c \\_\\_all__ = [] необходимо добавить название импортированной таблицы в кавычках. В нашем случае файл \\_\\_init__.py будет выглядеть так:\n```python\nfrom .test_table import Test\n\n__all__ = [\"Test\"]\n```\n3. Если у вас несколько таблиц, то в \\_\\_all__ их надо перечислять через запятую. К примеру:\n```python\nfrom .test_file_first import TestFirst, TestTrird\nfrom .test_file_second import TestSecond\n\n__all__ = [\"TestFirst\", \"TestSecond\", \"TestTrird\"]\n```\nПри этом порядок перечисления таблиц в \\_\\_all__ не важен\n\n4. После импортирования всех таблиц проведите миграцию, чтобы создались новые таблицы. Миграцию можно провести командами:\n```commandline\npython3 -m definitions revision --autogenerate -m \"название_вашей_миграции\"\npython3 -m definitions upgrade head\n```\nПерва команда создает ревизию - скрипт для перехода на новую версию базы данных.\nВторая команда обновляет базу данных (в данном случае создает новую таблицу Test)\n\n## Параметризация и плагины\nНикаких настроек кроме стандартных нет\n\n## Ссылки\n- Backend разработка – https://github.com/profcomff/.github/wiki/%5Bdev%5D-Backend-разработка\n- Работа с данными -https://github.com/profcomff/.github/wiki/%5Bdev%5D-Работа-с-данными\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofcomff%2Fdwh-definitions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprofcomff%2Fdwh-definitions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofcomff%2Fdwh-definitions/lists"}