Настройки проекта Planiqum¶

Запуск команд¶

Основные команды Django¶

# Все команды Django должны запускаться из директории src/
cd src/

# Запуск команд Django
python manage.py <command>

# Запуск сервера разработки
python manage.py runserver

# Запуск тестов
python manage.py test

Команды для работы с иерархиями¶

# Все команды должны запускаться из директории src/
cd src/

# Импорт иерархии из директории
python manage.py import_hierarchy_items_dir <path>

# Импорт конкретного уровня иерархии
python manage.py import_hierarchy_items <level_key> <filename>

# Загрузка структуры иерархии из YAML
python manage.py loadhierarchystructure <fixture_file>

Команды инициализации¶

# Все команды должны запускаться из директории src/
cd src/

# Инициализация базового проекта
python manage.py initializeproject

# Инициализация IBP
python manage.py init_ibp_base
python manage.py init_ibp_custom

Команды для работы с документацией¶

# Запуск сервера документации в режиме разработки
mkdocs serve

# Сборка документации
mkdocs build

# Проверка документации
mkdocs build --strict

Настройки окружения¶

Основные переменные окружения¶

# Путь к корневой директории проекта
PLANIQUM_PATH=/path/to/project

# Путь для импорта данных
IMPORT_ROOT=/path/to/import/directory

# Настройки базы данных
DATABASE_URL=postgresql://user:password@localhost:5432/dbname

Структура директорий¶

src/
  ├── manage.py
  ├── planiqum/
  │   ├── apps/
  │   │   └── test_basics/
  │   │       └── data/
  │   │           └── hierarchy/
  │   │               └── *.csv
  │   └── core/
  │       └── hierarchy/
  │           └── libs/
  │               └── import_hierarchy_items.py
  └── docs/
      ├── mkdocs.yml
      └── md/
          └── utils/
              └── project_settings.md

Форматы данных¶

CSV файлы иерархии¶

Обязательные колонки: shortname, description
Дополнительные колонки для связей: <parent_level_key>

Пример:

shortname,description,parent_level
DPU1,Торговая точка 1,REGION1
DPU2,Торговая точка 2,REGION1

YAML файлы структуры¶

Определяют типы и уровни иерархии

Пример:

- fields:
    shortname: Версии
    key: version
  model: hierarchy.type

Логирование импорта¶

При импорте данных создаются записи в "Журнале импортов" со следующими полями: - raw_data_count - количество обновлённых записей - updated_records_count - количество добавленных записей - deleted_relations_count - количество удалённых связей - updated_relations_count - количество обновлённых связей - added_relations_count - количество добавленных связей

Настройки документации¶

Структура навигации MkDocs¶

nav:
  - Главная: index.md
  - История изменений:
      - release_notes/0.8.1.md
  - Начало Работы:
      - beginning.md
      - beginning_install.md
      - beginning_windows.md
      - beginning_envs.md
      - beginning_startapp.md
  - Инструкция администратора:
      - admin/admin.md
      - admin/dashboards.md
      - admin/hierarchy.md
      # ...
  - Для Разработчиков:
      - Базовые понятия: dev/basic_concepts.md
      - Работа с API: dev/api_usage.md
      # ...
  - Утилиты:
      - utils/index.md
      - utils/reset_sequences.md
      # ...

Правила добавления документации¶

Все новые файлы документации должны быть добавлены в навигацию mkdocs.yml
Файлы должны быть размещены в соответствующих директориях:
md/dev/ - для документации разработчиков
md/admin/ - для документации администраторов
md/utils/ - для служебной документации
При добавлении нового файла необходимо:
Создать файл в соответствующей директории
Добавить ссылку в навигацию mkdocs.yml
Проверить корректность сборки документации