nightly-scripts 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. nightly-scripts-0.1.0/CHANGELOG.md +34 -0
  2. nightly-scripts-0.1.0/CONDUCT.md +55 -0
  3. nightly-scripts-0.1.0/LICENSE +30 -0
  4. nightly-scripts-0.1.0/MANIFEST.in +10 -0
  5. nightly-scripts-0.1.0/PKG-INFO +115 -0
  6. nightly-scripts-0.1.0/README.md +46 -0
  7. nightly-scripts-0.1.0/pyproject.toml +8 -0
  8. nightly-scripts-0.1.0/requirements/dependencies/development_packages.txt +5 -0
  9. nightly-scripts-0.1.0/requirements/dependencies/external_packages.txt +1 -0
  10. nightly-scripts-0.1.0/requirements/dependencies/internal_packages.txt +0 -0
  11. nightly-scripts-0.1.0/requirements/dependencies/internal_sources.txt +0 -0
  12. nightly-scripts-0.1.0/requirements/dependencies/production_packages.txt +2 -0
  13. nightly-scripts-0.1.0/requirements/dependencies/system_packages.txt +4 -0
  14. nightly-scripts-0.1.0/requirements/dependencies/testing_packages.txt +0 -0
  15. nightly-scripts-0.1.0/requirements/development.txt +5 -0
  16. nightly-scripts-0.1.0/requirements/production.txt +2 -0
  17. nightly-scripts-0.1.0/setup.cfg +36 -0
  18. nightly-scripts-0.1.0/setup.py +99 -0
  19. nightly-scripts-0.1.0/src/nightly_scripts/__init__.py +0 -0
  20. nightly-scripts-0.1.0/src/nightly_scripts/admin.py +3 -0
  21. nightly-scripts-0.1.0/src/nightly_scripts/apps.py +8 -0
  22. nightly-scripts-0.1.0/src/nightly_scripts/management/__init__.py +0 -0
  23. nightly-scripts-0.1.0/src/nightly_scripts/management/commands/__init__.py +0 -0
  24. nightly-scripts-0.1.0/src/nightly_scripts/management/commands/execute_nightly_scripts.py +41 -0
  25. nightly-scripts-0.1.0/src/nightly_scripts/migrations/__init__.py +0 -0
  26. nightly-scripts-0.1.0/src/nightly_scripts/models.py +3 -0
  27. nightly-scripts-0.1.0/src/nightly_scripts/tests.py +3 -0
  28. nightly-scripts-0.1.0/src/nightly_scripts/views.py +3 -0
  29. nightly-scripts-0.1.0/src/nightly_scripts.egg-info/PKG-INFO +115 -0
  30. nightly-scripts-0.1.0/src/nightly_scripts.egg-info/SOURCES.txt +34 -0
  31. nightly-scripts-0.1.0/src/nightly_scripts.egg-info/dependency_links.txt +1 -0
  32. nightly-scripts-0.1.0/src/nightly_scripts.egg-info/namespace_packages.txt +1 -0
  33. nightly-scripts-0.1.0/src/nightly_scripts.egg-info/not-zip-safe +1 -0
  34. nightly-scripts-0.1.0/src/nightly_scripts.egg-info/requires.txt +5 -0
  35. nightly-scripts-0.1.0/src/nightly_scripts.egg-info/top_level.txt +1 -0
@@ -0,0 +1,34 @@
1
+ # История изменений
2
+
3
+ Все изменения проекта должны быть отражены в этом файле.
4
+
5
+ Формат основан на [Keep a Changelog](http://keepachangelog.com/)
6
+ и проект следует [Семантическому версионированию](http://semver.org/).
7
+
8
+ ## [x.y.z] - гггг-мм-дд
9
+
10
+ Здесь должно быть расширенное описание того, что было сделано, какие есть планы у команды по дальнейшему развитию.
11
+ Желательно будущие цели привязывать к конкретным задачам. Т.е. на каждую цель нужно поставить отдельную задачу и
12
+ отразить ее номер здесь.
13
+
14
+ ### Добавлено
15
+
16
+ - [ПРОЕКТ-ZZZZ](https://jira.bars.group/browse/ПРОЕКТ-ZZZZ)
17
+ PATCH Название задачи или изменения.
18
+
19
+ - [ПРОЕКТ-YYYY](https://jira.bars.group/browse/ПРОЕКТ-YYYY)
20
+ MINOR Название задачи или изменения.
21
+
22
+ - [ПРОЕКТ-XXXX](https://jira.bars.group/browse/ПРОЕКТ-XXXX)
23
+ MAJOR Название задачи или изменения.
24
+
25
+ ### Изменено
26
+
27
+ ### Исправлено
28
+
29
+ ### Удалено
30
+
31
+
32
+ ## [0.1.0] - 2024-10-10
33
+
34
+ Инициализация проекта.
@@ -0,0 +1,55 @@
1
+ # Кодекс поведения
2
+
3
+ ## Договоренности
4
+
5
+ В интересах создания открытой и гостеприимной среды мы, как участники проекта, обязуемся сделать участие в нашем
6
+ сообществе свободным от предрасудков и дескриминации для всех, независимо от возраста, внешниго вида, этнической
7
+ принадлежности, вероисповидания, расы, национальности и уровня опыта.
8
+
9
+ ## Стандарты
10
+
11
+ Примерами поведения, которое способствует созданию гостеприимной среды, являются:
12
+
13
+ * Использование нормативной, дружелюбной речи и письма
14
+ * Уважительное отношение к различным точкам зрения и опыту
15
+ * Gracefully accepting constructive criticism
16
+ * Адекватное восприятие конструктивной критики
17
+ * Проявление эмпатии к другим участникам сообщества
18
+
19
+ Примерами неприемлемого поведения участников являются:
20
+
21
+ * Использование ненормативной лексики, иных материалов непристойного характера или политической направленности
22
+ * Троллинг, оскорбительные/уничижительные комментарии, а также переход на личности
23
+ * Публичное или персональное преследование
24
+ * Публикация личной информации других людей, такой как адресные данные, без явного разрешения
25
+ * Иное поведение, которое можно обоснованно считать неуместным в профессиональной среде
26
+
27
+ ## Обязательства
28
+
29
+ Ответственные за сопровождение проекта отвечают за актуализацию стандартов приемлемого поведения. Также ожидается, что
30
+ они предпримут соответствующие справедливые действия в ответ на любые случаи неприемлемого поведения.
31
+
32
+ Ответственные за сопровождение проекта имеют право и обязаны удалять, редактировать или отклонять код, содержащиий
33
+ информацию, которые не соответствуют настоящему Кодексу поведения, или временно или навсегда заблокировать любого
34
+ участника за иное поведение, которое они считают неуместными, оскорбительными или вредными для сообщества проекта.
35
+
36
+ ## Область применения
37
+
38
+ Этот Кодекс поведения применяется как внутри компании, так и за ее пределами, когда человек представляет проект или его
39
+ сообщество. Демонстрация проекта или материалов, связанных с ним, должны включать официальный адрес проекта.
40
+ Представление проекта может быть дополнительно определено и уточнено ответственными за сопровождение проекта.
41
+
42
+ ## Правоприменение
43
+
44
+ О случаях оскорбительного, агрессивного или иного неприемлемого поведения можно сообщить, связавшись с командой проекта.
45
+ Команда проекта рассмотрит и расследует все жалобы и отреагирует так, как сочтет нужным в данных обстоятельствах.
46
+ Команда проекта обязана сохранять конфиденциальность в отношении лица, сообщившего об инциденте. Дополнительные сведения
47
+ о конкретных политиках правоприменения могут быть опубликованы отдельно.
48
+
49
+ Ответственные за сопровождение проекта, которые не соблюдают или не обеспечивают добросовестное соблюдение Кодекса
50
+ поведения, могут быть временно или на постоянной основе отстранены от участия в проекте.
51
+
52
+ ## Дополнительная информация
53
+
54
+ Данный Кодекс поведения является адаптацией
55
+ [Соглашения участников проекта](http://contributor-covenant.org/version/1/4), версия 1.4.
@@ -0,0 +1,30 @@
1
+ Copyright © 2022 ЗАО “БАРС Груп”
2
+
3
+ Данная лицензия разрешает лицам, получившим копию данного программного обеспечения и сопутствующей документации (в дальнейшем
4
+ именуемыми «Программное Обеспечение»), безвозмездно использовать Программное Обеспечение без ограничений, включая неограниченное
5
+ право на использование, копирование, изменение, добавление, публикацию, распространение, сублицензирование и/или продажу копий
6
+ Программного Обеспечения, также как и лицам, которым предоставляется данное Программное Обеспечение, при соблюдении следующих
7
+ условий:
8
+
9
+ Указанное выше уведомление об авторском праве и данные условия должны быть включены во все копии или значимые части данного
10
+ Программного Обеспечения.
11
+
12
+ ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ,
13
+ НО НЕ ОГРАНИЧИВАЯСЬ ГАРАНТИЯМИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ ПРАВ.
14
+ НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ПО ИСКАМ О ВОЗМЕЩЕНИИ УЩЕРБА, УБЫТКОВ ИЛИ ДРУГИХ ТРЕБОВАНИЙ
15
+ ПО ДЕЙСТВУЮЩИМ КОНТРАКТАМ, ДЕЛИКТАМ ИЛИ ИНОМУ, ВОЗНИКШИМ ИЗ, ИМЕЮЩИМ ПРИЧИНОЙ ИЛИ СВЯЗАННЫМ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ
16
+ ИСПОЛЬЗОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫМИ ДЕЙСТВИЯМИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.
17
+
18
+ Copyright © 2022 BARS Group
19
+
20
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
21
+ (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
22
+ merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
23
+ furnished to do so, subject to the following conditions:
24
+
25
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
26
+
27
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
28
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
29
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
30
+ IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,10 @@
1
+ global-exclude *.pyc
2
+ recursive-include src *.js
3
+ recursive-include src *.py
4
+ recursive-include src *.py-tpl
5
+ recursive-include requirements *.txt
6
+ include LICENSE
7
+ include setup.py
8
+ include CHANGELOG.md
9
+ include CONDUCT.md
10
+ include README.md
@@ -0,0 +1,115 @@
1
+ Metadata-Version: 2.1
2
+ Name: nightly-scripts
3
+ Version: 0.1.0
4
+ Summary: Ночные скрипты
5
+ Home-page:
6
+ Download-URL:
7
+ Author: BARS Group
8
+ Author-email: bars@bars.group
9
+ Platform: Any
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: License :: OSI Approved :: Apache Software License
12
+ Classifier: Programming Language :: Python
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.9
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Intended Audience :: Developers
19
+ Classifier: Environment :: Console
20
+ Classifier: Framework :: Django :: 2.2
21
+ Classifier: Framework :: Django :: 3.0
22
+ Classifier: Framework :: Django :: 3.1
23
+ Classifier: Framework :: Django :: 3.2
24
+ Classifier: Framework :: Django :: 4.0
25
+ Classifier: Framework :: Django :: 4.1
26
+ Classifier: Framework :: Django :: 4.2
27
+ Classifier: Framework :: Django :: 5.0
28
+ Description-Content-Type: text/markdown
29
+ License-File: LICENSE
30
+ Requires-Dist: packaging<24,>=21.3
31
+ Requires-Dist: pip<24,>=23.2.1
32
+ Requires-Dist: setuptools<70,>=47.3.1
33
+ Requires-Dist: wheel<0.42,>=0.37.1
34
+ Requires-Dist: Django<5.2,>=2.2
35
+
36
+ # Проект "Ночные скрипты"
37
+
38
+ По мере развития любого проекта необходимо заботиться о состоянии развернутого приложения в проде. Должны выполняться
39
+ такие задачи, как:
40
+
41
+ - Очистка устаревших файлов;
42
+ - Зачистка служебных записей по истечении времени хранения;
43
+ - Иные служебные задачи.
44
+
45
+ Данный пакет предоставляет довольно простую функцию - запуск Django-команд помеченных атрибутом `nightly_script = True`.
46
+ В основе лежит команда `execute_nightly_scripts`, которая осуществляет запуск ночных скриптов. Данная команда должна
47
+ запускаться по cron-у или другим аналогичным средством.
48
+
49
+ ## Требования к окружению
50
+
51
+ Для работы требуется Python >=3.9. Так же в зависимостях есть пакеты:
52
+
53
+ - Django>=3.2.
54
+
55
+ Версии всех пакетов уточнены в файлах с зависимостями.
56
+
57
+ ## Параметры конфигурационного файла
58
+
59
+ В разных проектах существуют различные способы добавления настроек, где-то через плагины, где-то напрямую в settings.py.
60
+ Будет рассмотрен подход указания настроек в settings.py и указания параметров в конфигурационном файле.
61
+
62
+ Для возможности конфигурирования необходимо проделать ряд действий:
63
+
64
+ - Добавить пакет `nightly_scripts` в INSTALLED_APPS в settings.py:
65
+ ```
66
+ INSTALLED_APPS = (
67
+ <some_app>,
68
+ ...,
69
+ 'nightly_scripts',
70
+ )
71
+ ```
72
+
73
+ ## Сборка и распространение
74
+
75
+ Сборка пакета производится при помощи [Job-а в Jenkins M3.build_dist](http://jenkins.py.bars.group/view/PY/job/M3.packages/job/M3.build_dist/).
76
+
77
+ Пакет выкладывается в глобальный [PYPI](https://pypi.org/project/edu-rdm-integration/) и во внутренний [Nexus](http://nexus.py.bars.group/#browse/browse:pypi-edu-private:edu-rdm-integration)
78
+
79
+ ## Документация
80
+
81
+ С документацией можно ознакомиться по ссылке http://docs.py.bars.group/nigtly-scripts/
82
+ # История изменений
83
+
84
+ Все изменения проекта должны быть отражены в этом файле.
85
+
86
+ Формат основан на [Keep a Changelog](http://keepachangelog.com/)
87
+ и проект следует [Семантическому версионированию](http://semver.org/).
88
+
89
+ ## [x.y.z] - гггг-мм-дд
90
+
91
+ Здесь должно быть расширенное описание того, что было сделано, какие есть планы у команды по дальнейшему развитию.
92
+ Желательно будущие цели привязывать к конкретным задачам. Т.е. на каждую цель нужно поставить отдельную задачу и
93
+ отразить ее номер здесь.
94
+
95
+ ### Добавлено
96
+
97
+ - [ПРОЕКТ-ZZZZ](https://jira.bars.group/browse/ПРОЕКТ-ZZZZ)
98
+ PATCH Название задачи или изменения.
99
+
100
+ - [ПРОЕКТ-YYYY](https://jira.bars.group/browse/ПРОЕКТ-YYYY)
101
+ MINOR Название задачи или изменения.
102
+
103
+ - [ПРОЕКТ-XXXX](https://jira.bars.group/browse/ПРОЕКТ-XXXX)
104
+ MAJOR Название задачи или изменения.
105
+
106
+ ### Изменено
107
+
108
+ ### Исправлено
109
+
110
+ ### Удалено
111
+
112
+
113
+ ## [0.1.0] - 2024-10-10
114
+
115
+ Инициализация проекта.
@@ -0,0 +1,46 @@
1
+ # Проект "Ночные скрипты"
2
+
3
+ По мере развития любого проекта необходимо заботиться о состоянии развернутого приложения в проде. Должны выполняться
4
+ такие задачи, как:
5
+
6
+ - Очистка устаревших файлов;
7
+ - Зачистка служебных записей по истечении времени хранения;
8
+ - Иные служебные задачи.
9
+
10
+ Данный пакет предоставляет довольно простую функцию - запуск Django-команд помеченных атрибутом `nightly_script = True`.
11
+ В основе лежит команда `execute_nightly_scripts`, которая осуществляет запуск ночных скриптов. Данная команда должна
12
+ запускаться по cron-у или другим аналогичным средством.
13
+
14
+ ## Требования к окружению
15
+
16
+ Для работы требуется Python >=3.9. Так же в зависимостях есть пакеты:
17
+
18
+ - Django>=3.2.
19
+
20
+ Версии всех пакетов уточнены в файлах с зависимостями.
21
+
22
+ ## Параметры конфигурационного файла
23
+
24
+ В разных проектах существуют различные способы добавления настроек, где-то через плагины, где-то напрямую в settings.py.
25
+ Будет рассмотрен подход указания настроек в settings.py и указания параметров в конфигурационном файле.
26
+
27
+ Для возможности конфигурирования необходимо проделать ряд действий:
28
+
29
+ - Добавить пакет `nightly_scripts` в INSTALLED_APPS в settings.py:
30
+ ```
31
+ INSTALLED_APPS = (
32
+ <some_app>,
33
+ ...,
34
+ 'nightly_scripts',
35
+ )
36
+ ```
37
+
38
+ ## Сборка и распространение
39
+
40
+ Сборка пакета производится при помощи [Job-а в Jenkins M3.build_dist](http://jenkins.py.bars.group/view/PY/job/M3.packages/job/M3.build_dist/).
41
+
42
+ Пакет выкладывается в глобальный [PYPI](https://pypi.org/project/edu-rdm-integration/) и во внутренний [Nexus](http://nexus.py.bars.group/#browse/browse:pypi-edu-private:edu-rdm-integration)
43
+
44
+ ## Документация
45
+
46
+ С документацией можно ознакомиться по ссылке http://docs.py.bars.group/nigtly-scripts/
@@ -0,0 +1,8 @@
1
+ [build-system]
2
+ requires = [
3
+ "packaging>=21.3,<24",
4
+ "setuptools>=47.3.1,<70",
5
+ "wheel>=0.37.1,<0.42",
6
+ "pip>=23.2.1,<24"
7
+ ]
8
+ build-backend = "setuptools.build_meta"
@@ -0,0 +1,5 @@
1
+ isort>=5.10.1,<6
2
+ flake8>=4.0.1,<7
3
+ pytest>=3.2.5,<8
4
+ pytest-cov<5
5
+ python-semantic-release<9
@@ -0,0 +1,2 @@
1
+ -r external_packages.txt
2
+ -r internal_packages.txt
@@ -0,0 +1,4 @@
1
+ packaging>=21.3,<24
2
+ pip>=23.2.1,<24
3
+ setuptools>=47.3.1,<70
4
+ wheel>=0.37.1,<0.42
@@ -0,0 +1,5 @@
1
+ -r dependencies/system_packages.txt
2
+ -r dependencies/external_packages.txt
3
+ -r dependencies/internal_sources.txt
4
+ -r dependencies/development_packages.txt
5
+ -r dependencies/testing_packages.txt
@@ -0,0 +1,2 @@
1
+ -r dependencies/system_packages.txt
2
+ -r dependencies/production_packages.txt
@@ -0,0 +1,36 @@
1
+ [metadata]
2
+ description-file = README.md
3
+
4
+ [flake8]
5
+ max-line-length = 120
6
+ ignore =
7
+ D100,
8
+ D104,
9
+ D106,
10
+ D107,
11
+ D200,
12
+ W503,
13
+ S101,
14
+ per-file-ignores =
15
+ wsmodel.py:N815
16
+ wsapi.py:N802,N815
17
+ exclude =
18
+ venv,
19
+ max-complexity = 10
20
+
21
+ [pylint]
22
+ score = no
23
+ msg-template = {path}:{line} {msg} ({symbol})
24
+ disable = all
25
+ enable =
26
+ import-error,
27
+ no-name-in-module,
28
+ undefined-variable,
29
+ undefined-all-variable,
30
+ extension-pkg-whitelist =
31
+ lxml,
32
+
33
+ [egg_info]
34
+ tag_build =
35
+ tag_date = 0
36
+
@@ -0,0 +1,99 @@
1
+ from codecs import (
2
+ open,
3
+ )
4
+ from pathlib import (
5
+ Path,
6
+ )
7
+
8
+ from pip._internal.network.session import (
9
+ PipSession,
10
+ )
11
+ from pip._internal.req import (
12
+ parse_requirements,
13
+ )
14
+ from setuptools import (
15
+ find_packages,
16
+ setup,
17
+ )
18
+
19
+
20
+ PROJECT = 'nightly-scripts'
21
+
22
+ VERSION = '0.1.0'
23
+
24
+ current_dir_path = Path().resolve()
25
+
26
+
27
+ # Получение полного описания
28
+ with open(str(current_dir_path / 'README.md'), encoding='utf-8') as f:
29
+ long_description = f.read()
30
+
31
+ with open(str(current_dir_path / 'CHANGELOG.md'), encoding='utf-8') as f:
32
+ long_description += f.read()
33
+
34
+ production_requirements_path = current_dir_path / 'requirements' / 'production.txt'
35
+
36
+ requirements = parse_requirements(str(production_requirements_path), session=PipSession())
37
+
38
+ install_requires = [str(item.requirement) for item in requirements]
39
+
40
+ setup(
41
+ name=PROJECT,
42
+ version=VERSION,
43
+
44
+ description='Ночные скрипты',
45
+ long_description=long_description,
46
+ long_description_content_type='text/markdown',
47
+
48
+ author='BARS Group',
49
+ author_email='bars@bars.group',
50
+
51
+ url='',
52
+ download_url='',
53
+
54
+ classifiers=[
55
+ 'Development Status :: 3 - Alpha',
56
+ 'License :: OSI Approved :: Apache Software License',
57
+ 'Programming Language :: Python',
58
+ 'Programming Language :: Python :: 3',
59
+ 'Programming Language :: Python :: 3.9',
60
+ 'Programming Language :: Python :: 3.10',
61
+ 'Programming Language :: Python :: 3.11',
62
+ 'Programming Language :: Python :: 3.12',
63
+ 'Intended Audience :: Developers',
64
+ 'Environment :: Console',
65
+ 'Framework :: Django :: 2.2',
66
+ 'Framework :: Django :: 3.0',
67
+ 'Framework :: Django :: 3.1',
68
+ 'Framework :: Django :: 3.2',
69
+ 'Framework :: Django :: 4.0',
70
+ 'Framework :: Django :: 4.1',
71
+ 'Framework :: Django :: 4.2',
72
+ 'Framework :: Django :: 5.0',
73
+ ],
74
+
75
+ platforms=['Any'],
76
+
77
+ scripts=[],
78
+
79
+ provides=[],
80
+
81
+ namespace_packages=[],
82
+ package_dir={'': 'src'},
83
+ packages=find_packages('src', exclude=('tests', 'tests.*')),
84
+ include_package_data=True,
85
+
86
+ package_data={
87
+ '': [
88
+ '*.conf',
89
+ '*.tmpl',
90
+ '*.sh',
91
+ 'Dockerfile',
92
+ '*.yaml',
93
+ ],
94
+ },
95
+
96
+ install_requires=install_requires,
97
+
98
+ zip_safe=False,
99
+ )
File without changes
@@ -0,0 +1,3 @@
1
+ from django.contrib import (
2
+ admin,
3
+ )
@@ -0,0 +1,8 @@
1
+ from django.apps import (
2
+ AppConfig,
3
+ )
4
+
5
+
6
+ class NightlyScriptsConfig(AppConfig):
7
+ default_auto_field = 'django.db.models.BigAutoField'
8
+ name = 'nightly_scripts'
@@ -0,0 +1,41 @@
1
+ from django.core.management import (
2
+ BaseCommand,
3
+ call_command,
4
+ get_commands,
5
+ load_command_class,
6
+ )
7
+
8
+
9
+ class Command(BaseCommand):
10
+ """Точка входа для запуска периодических ночных скриптов.
11
+
12
+ Более подробную информацию можно найти по ссылке https://conf.bars.group/pages/viewpage.action?pageId=312294857
13
+ """
14
+
15
+ help = 'Выполнение ночных скриптов'
16
+
17
+ def handle(self, *args, **options):
18
+ commands = get_commands()
19
+
20
+ for command_name, package in commands.items():
21
+ if isinstance(package, BaseCommand):
22
+ command = package
23
+ else:
24
+ try:
25
+ command = load_command_class(package, command_name)
26
+ except Exception as e:
27
+ print(
28
+ f'Возникла ошибка "{e}" при обработке команды "{command_name}" из пакета "{package}". '
29
+ f'Команда пропущена'
30
+ )
31
+ continue
32
+
33
+ if getattr(command, 'nightly_script', False):
34
+ print(f'Запуск скрипта "{command.help}"')
35
+
36
+ try:
37
+ call_command(command)
38
+ except Exception:
39
+ print(f'Скрипт "{command.help}" завершен с ошибкой')
40
+ else:
41
+ print(f'Скрипт "{command.help}" завершен успешно')
@@ -0,0 +1,3 @@
1
+ from django.db import (
2
+ models,
3
+ )
@@ -0,0 +1,3 @@
1
+ from django.test import (
2
+ TestCase,
3
+ )
@@ -0,0 +1,3 @@
1
+ from django.shortcuts import (
2
+ render,
3
+ )
@@ -0,0 +1,115 @@
1
+ Metadata-Version: 2.1
2
+ Name: nightly-scripts
3
+ Version: 0.1.0
4
+ Summary: Ночные скрипты
5
+ Home-page:
6
+ Download-URL:
7
+ Author: BARS Group
8
+ Author-email: bars@bars.group
9
+ Platform: Any
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: License :: OSI Approved :: Apache Software License
12
+ Classifier: Programming Language :: Python
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.9
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Intended Audience :: Developers
19
+ Classifier: Environment :: Console
20
+ Classifier: Framework :: Django :: 2.2
21
+ Classifier: Framework :: Django :: 3.0
22
+ Classifier: Framework :: Django :: 3.1
23
+ Classifier: Framework :: Django :: 3.2
24
+ Classifier: Framework :: Django :: 4.0
25
+ Classifier: Framework :: Django :: 4.1
26
+ Classifier: Framework :: Django :: 4.2
27
+ Classifier: Framework :: Django :: 5.0
28
+ Description-Content-Type: text/markdown
29
+ License-File: LICENSE
30
+ Requires-Dist: packaging<24,>=21.3
31
+ Requires-Dist: pip<24,>=23.2.1
32
+ Requires-Dist: setuptools<70,>=47.3.1
33
+ Requires-Dist: wheel<0.42,>=0.37.1
34
+ Requires-Dist: Django<5.2,>=2.2
35
+
36
+ # Проект "Ночные скрипты"
37
+
38
+ По мере развития любого проекта необходимо заботиться о состоянии развернутого приложения в проде. Должны выполняться
39
+ такие задачи, как:
40
+
41
+ - Очистка устаревших файлов;
42
+ - Зачистка служебных записей по истечении времени хранения;
43
+ - Иные служебные задачи.
44
+
45
+ Данный пакет предоставляет довольно простую функцию - запуск Django-команд помеченных атрибутом `nightly_script = True`.
46
+ В основе лежит команда `execute_nightly_scripts`, которая осуществляет запуск ночных скриптов. Данная команда должна
47
+ запускаться по cron-у или другим аналогичным средством.
48
+
49
+ ## Требования к окружению
50
+
51
+ Для работы требуется Python >=3.9. Так же в зависимостях есть пакеты:
52
+
53
+ - Django>=3.2.
54
+
55
+ Версии всех пакетов уточнены в файлах с зависимостями.
56
+
57
+ ## Параметры конфигурационного файла
58
+
59
+ В разных проектах существуют различные способы добавления настроек, где-то через плагины, где-то напрямую в settings.py.
60
+ Будет рассмотрен подход указания настроек в settings.py и указания параметров в конфигурационном файле.
61
+
62
+ Для возможности конфигурирования необходимо проделать ряд действий:
63
+
64
+ - Добавить пакет `nightly_scripts` в INSTALLED_APPS в settings.py:
65
+ ```
66
+ INSTALLED_APPS = (
67
+ <some_app>,
68
+ ...,
69
+ 'nightly_scripts',
70
+ )
71
+ ```
72
+
73
+ ## Сборка и распространение
74
+
75
+ Сборка пакета производится при помощи [Job-а в Jenkins M3.build_dist](http://jenkins.py.bars.group/view/PY/job/M3.packages/job/M3.build_dist/).
76
+
77
+ Пакет выкладывается в глобальный [PYPI](https://pypi.org/project/edu-rdm-integration/) и во внутренний [Nexus](http://nexus.py.bars.group/#browse/browse:pypi-edu-private:edu-rdm-integration)
78
+
79
+ ## Документация
80
+
81
+ С документацией можно ознакомиться по ссылке http://docs.py.bars.group/nigtly-scripts/
82
+ # История изменений
83
+
84
+ Все изменения проекта должны быть отражены в этом файле.
85
+
86
+ Формат основан на [Keep a Changelog](http://keepachangelog.com/)
87
+ и проект следует [Семантическому версионированию](http://semver.org/).
88
+
89
+ ## [x.y.z] - гггг-мм-дд
90
+
91
+ Здесь должно быть расширенное описание того, что было сделано, какие есть планы у команды по дальнейшему развитию.
92
+ Желательно будущие цели привязывать к конкретным задачам. Т.е. на каждую цель нужно поставить отдельную задачу и
93
+ отразить ее номер здесь.
94
+
95
+ ### Добавлено
96
+
97
+ - [ПРОЕКТ-ZZZZ](https://jira.bars.group/browse/ПРОЕКТ-ZZZZ)
98
+ PATCH Название задачи или изменения.
99
+
100
+ - [ПРОЕКТ-YYYY](https://jira.bars.group/browse/ПРОЕКТ-YYYY)
101
+ MINOR Название задачи или изменения.
102
+
103
+ - [ПРОЕКТ-XXXX](https://jira.bars.group/browse/ПРОЕКТ-XXXX)
104
+ MAJOR Название задачи или изменения.
105
+
106
+ ### Изменено
107
+
108
+ ### Исправлено
109
+
110
+ ### Удалено
111
+
112
+
113
+ ## [0.1.0] - 2024-10-10
114
+
115
+ Инициализация проекта.
@@ -0,0 +1,34 @@
1
+ CHANGELOG.md
2
+ CONDUCT.md
3
+ LICENSE
4
+ MANIFEST.in
5
+ README.md
6
+ pyproject.toml
7
+ setup.cfg
8
+ setup.py
9
+ requirements/development.txt
10
+ requirements/production.txt
11
+ requirements/dependencies/development_packages.txt
12
+ requirements/dependencies/external_packages.txt
13
+ requirements/dependencies/internal_packages.txt
14
+ requirements/dependencies/internal_sources.txt
15
+ requirements/dependencies/production_packages.txt
16
+ requirements/dependencies/system_packages.txt
17
+ requirements/dependencies/testing_packages.txt
18
+ src/nightly_scripts/__init__.py
19
+ src/nightly_scripts/admin.py
20
+ src/nightly_scripts/apps.py
21
+ src/nightly_scripts/models.py
22
+ src/nightly_scripts/tests.py
23
+ src/nightly_scripts/views.py
24
+ src/nightly_scripts.egg-info/PKG-INFO
25
+ src/nightly_scripts.egg-info/SOURCES.txt
26
+ src/nightly_scripts.egg-info/dependency_links.txt
27
+ src/nightly_scripts.egg-info/namespace_packages.txt
28
+ src/nightly_scripts.egg-info/not-zip-safe
29
+ src/nightly_scripts.egg-info/requires.txt
30
+ src/nightly_scripts.egg-info/top_level.txt
31
+ src/nightly_scripts/management/__init__.py
32
+ src/nightly_scripts/management/commands/__init__.py
33
+ src/nightly_scripts/management/commands/execute_nightly_scripts.py
34
+ src/nightly_scripts/migrations/__init__.py
@@ -0,0 +1,5 @@
1
+ packaging<24,>=21.3
2
+ pip<24,>=23.2.1
3
+ setuptools<70,>=47.3.1
4
+ wheel<0.42,>=0.37.1
5
+ Django<5.2,>=2.2
@@ -0,0 +1 @@
1
+ nightly_scripts