nightly-scripts 0.1.0

Ночные скрипты

Проект "Ночные скрипты"

По мере развития любого проекта необходимо заботиться о состоянии развернутого приложения в проде. Должны выполняться такие задачи, как:

• Очистка устаревших файлов;
• Зачистка служебных записей по истечении времени хранения;
• Иные служебные задачи.

Данный пакет предоставляет довольно простую функцию - запуск Django-команд помеченных атрибутом nightly_script = True. В основе лежит команда execute_nightly_scripts, которая осуществляет запуск ночных скриптов. Данная команда должна запускаться по cron-у или другим аналогичным средством.

Требования к окружению

Для работы требуется Python >=3.9. Так же в зависимостях есть пакеты:

• Django>=3.2.

Версии всех пакетов уточнены в файлах с зависимостями.

Параметры конфигурационного файла

В разных проектах существуют различные способы добавления настроек, где-то через плагины, где-то напрямую в settings.py. Будет рассмотрен подход указания настроек в settings.py и указания параметров в конфигурационном файле.

Для возможности конфигурирования необходимо проделать ряд действий:

• Добавить пакет nightly_scripts в INSTALLED_APPS в settings.py:

  INSTALLED_APPS = (
      <some_app>,
      ...,
      'nightly_scripts',
  )
  

Сборка и распространение

Сборка пакета производится при помощи Job-а в Jenkins M3.build_dist.

Пакет выкладывается в глобальный PYPI и во внутренний Nexus

Документация

С документацией можно ознакомиться по ссылке http://docs.py.bars.group/nigtly-scripts/

История изменений

Все изменения проекта должны быть отражены в этом файле.

Формат основан на Keep a Changelog и проект следует Семантическому версионированию.

[x.y.z] - гггг-мм-дд

Здесь должно быть расширенное описание того, что было сделано, какие есть планы у команды по дальнейшему развитию. Желательно будущие цели привязывать к конкретным задачам. Т.е. на каждую цель нужно поставить отдельную задачу и отразить ее номер здесь.

Добавлено

• ПРОЕКТ-ZZZZ PATCH Название задачи или изменения.

• ПРОЕКТ-YYYY MINOR Название задачи или изменения.

• ПРОЕКТ-XXXX MAJOR Название задачи или изменения.

Изменено

Исправлено

Удалено

[0.1.0] - 2024-10-10

Инициализация проекта.