django-school-framework 0.2.2__tar.gz

django_school_framework-0.2.2/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: django-school-framework
+Version: 0.2.2
+Summary: Відкритий веб-фреймворк для офіційних сайтів закладів загальної середньої освіти України (ст. 30 ЗУ «Про освіту»)
+License: MIT
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.1
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Intended Audience :: Education
+Classifier: Topic :: Education
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: Django<5.2,>=5.1
+Requires-Dist: djangorestframework>=3.15.2
+Requires-Dist: django-cors-headers>=4.4.0
+Requires-Dist: drf-spectacular>=0.27.2
+Requires-Dist: django-filter>=24.3
+Requires-Dist: pillow>=10.4.0
+Provides-Extra: mysql
+Requires-Dist: PyMySQL>=1.1.1; extra == "mysql"
+Requires-Dist: mysqlclient>=2.2.4; extra == "mysql"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-django>=4.8.0; extra == "dev"
+
+# Django School Framework
+
+Модульний веб-фреймворк для офіційних сайтів закладів загальної середньої освіти України відповідно до ст. 30 ЗУ «Про освіту».
+
+## Встановлення
+
+```bash
+pip install django-school-framework
+```
+
+## Швидкий старт
+
+Додайте необхідні додатки у ваш `settings.py`:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    'apps.core',
+    'apps.legal',
+    'apps.admissions',
+    'apps.nutrition',
+    'apps.safety',
+    'apps.news',
+    'apps.schedule',
+    'apps.gallery',
+]
+```

django_school_framework-0.2.2/README.md

@@ -0,0 +1,27 @@
+# Django School Framework
+
+Модульний веб-фреймворк для офіційних сайтів закладів загальної середньої освіти України відповідно до ст. 30 ЗУ «Про освіту».
+
+## Встановлення
+
+```bash
+pip install django-school-framework
+```
+
+## Швидкий старт
+
+Додайте необхідні додатки у ваш `settings.py`:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    'apps.core',
+    'apps.legal',
+    'apps.admissions',
+    'apps.nutrition',
+    'apps.safety',
+    'apps.news',
+    'apps.schedule',
+    'apps.gallery',
+]
+```

django_school_framework-0.2.2/apps/__init__.py

@@ -0,0 +1 @@
+# Apps package

django_school_framework-0.2.2/apps/admissions/admin.py

@@ -0,0 +1,28 @@
+from django.contrib import admin
+from .models import ServiceTerritory, ClassCapacity, EnrolledStudent, AdmissionLottery
+
+class EnrolledStudentInline(admin.TabularInline):
+    model = EnrolledStudent
+    extra = 1
+    fields = ('last_name', 'enrollment_date', 'order_number', 'is_lottery')
+
+@admin.register(ServiceTerritory)
+class ServiceTerritoryAdmin(admin.ModelAdmin):
+    list_display = ('street_name', 'building_numbers', 'district')
+    search_fields = ('street_name', 'building_numbers')
+
+@admin.register(ClassCapacity)
+class ClassCapacityAdmin(admin.ModelAdmin):
+    list_display = ('grade_name', 'total_capacity', 'enrolled_count', 'available_slots', 'updated_at')
+    inlines = [EnrolledStudentInline]
+
+@admin.register(EnrolledStudent)
+class EnrolledStudentAdmin(admin.ModelAdmin):
+    list_display = ('last_name', 'grade', 'enrollment_date', 'order_number', 'is_lottery')
+    list_filter = ('grade', 'is_lottery')
+    search_fields = ('last_name',)
+
+@admin.register(AdmissionLottery)
+class AdmissionLotteryAdmin(admin.ModelAdmin):
+    list_display = ('title', 'target_grade', 'lottery_datetime', 'available_places', 'candidates_count', 'is_completed')
+    list_filter = ('is_completed',)

django_school_framework-0.2.2/apps/admissions/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+class AdmissionsConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'apps.admissions'
+    verbose_name = 'Зарахування учнів, територія та вільні місця'

django_school_framework-0.2.2/apps/admissions/migrations/0001_initial.py

@@ -0,0 +1,80 @@
+# Generated by Django 5.1.15 on 2026-10-15 06:10
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='AdmissionLottery',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('title', models.CharField(max_length=255, verbose_name='Тема оголошення жеребкування')),
+                ('target_grade', models.CharField(max_length=50, verbose_name='Клас для жеребкування')),
+                ('lottery_datetime', models.DateTimeField(verbose_name='Дата і час проведення жеребкування')),
+                ('location', models.CharField(max_length=255, verbose_name='Місце та спосіб проведення (актова зала, онлайн-трансляція)')),
+                ('available_places', models.PositiveIntegerField(verbose_name='Кількість вільних місць')),
+                ('candidates_count', models.PositiveIntegerField(verbose_name='Кількість дітей-претендентів')),
+                ('committee_order_doc', models.FileField(upload_to='admissions/lottery/', verbose_name='Наказ про утворення конкурсної комісії з 3 осіб')),
+                ('is_completed', models.BooleanField(default=False, verbose_name='Жеребкування проведено')),
+            ],
+            options={
+                'verbose_name': 'Жеребкування на вільні місця',
+                'verbose_name_plural': 'Жеребкування на вільні місця',
+                'ordering': ['-lottery_datetime'],
+            },
+        ),
+        migrations.CreateModel(
+            name='ClassCapacity',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('grade_name', models.CharField(max_length=50, verbose_name='Клас / паралель (наприклад: 1-А, 10-А)')),
+                ('total_capacity', models.PositiveIntegerField(verbose_name='Спроможність класу')),
+                ('enrolled_count', models.PositiveIntegerField(verbose_name='Фактично зараховано')),
+                ('updated_at', models.DateTimeField(auto_now=True, verbose_name='Дата оновлення даних')),
+            ],
+            options={
+                'verbose_name': 'Спроможність та вільні місця',
+                'verbose_name_plural': 'Наявність вільних місць у класах (п. 7 Порядку)',
+                'ordering': ['grade_name'],
+            },
+        ),
+        migrations.CreateModel(
+            name='ServiceTerritory',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('street_name', models.CharField(max_length=200, verbose_name='Вулиця / проспект / провулок')),
+                ('building_numbers', models.CharField(max_length=255, verbose_name='Номери будинків (діапазон або перелік)')),
+                ('district', models.CharField(blank=True, max_length=100, verbose_name='Район міста / громада')),
+                ('decision_doc', models.CharField(blank=True, max_length=255, verbose_name='Рішення / розпорядження про закріплення')),
+            ],
+            options={
+                'verbose_name': 'Адреса закріпленої території',
+                'verbose_name_plural': 'Територія обслуговування (закріплені вулиці)',
+                'ordering': ['street_name'],
+            },
+        ),
+        migrations.CreateModel(
+            name='EnrolledStudent',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('last_name', models.CharField(max_length=100, verbose_name='Прізвище зарахованої дитини (виключно прізвище)')),
+                ('enrollment_date', models.DateField(verbose_name='Дата зарахування')),
+                ('order_number', models.CharField(blank=True, max_length=100, verbose_name='Номер наказу про зарахування')),
+                ('is_lottery', models.BooleanField(default=False, verbose_name='Зараховано за результатами жеребкування')),
+                ('grade', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='students', to='admissions.classcapacity', verbose_name='Клас')),
+            ],
+            options={
+                'verbose_name': 'Зарахований учень (захист персональних даних)',
+                'verbose_name_plural': 'Списки зарахованих учнів (прізвища)',
+                'ordering': ['grade', 'last_name'],
+            },
+        ),
+    ]

django_school_framework-0.2.2/apps/admissions/models.py

@@ -0,0 +1,105 @@
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+class AbstractServiceTerritory(models.Model):
+    street_name = models.CharField(max_length=200, verbose_name=_('Вулиця / проспект / провулок'))
+    building_numbers = models.CharField(max_length=255, verbose_name=_('Номери будинків (діапазон або перелік)'))
+    district = models.CharField(max_length=100, blank=True, verbose_name=_('Район міста / громада'))
+    decision_doc = models.CharField(max_length=255, blank=True, verbose_name=_('Рішення / розпорядження про закріплення'))
+
+    class Meta:
+        abstract = True
+        verbose_name = _('Адреса закріпленої території')
+        verbose_name_plural = _('Територія обслуговування (закріплені вулиці)')
+        ordering = ['street_name']
+
+    def __str__(self):
+        return f"{self.street_name} ({self.building_numbers})"
+
+
+class ServiceTerritory(AbstractServiceTerritory):
+    class Meta(AbstractServiceTerritory.Meta):
+        abstract = False
+
+
+class AbstractClassCapacity(models.Model):
+    grade_name = models.CharField(max_length=50, verbose_name=_('Клас / паралель (наприклад: 1-А, 10-А)'))
+    total_capacity = models.PositiveIntegerField(verbose_name=_('Спроможність класу'))
+    enrolled_count = models.PositiveIntegerField(verbose_name=_('Фактично зараховано'))
+    updated_at = models.DateTimeField(auto_now=True, verbose_name=_('Дата оновлення даних'))
+
+    class Meta:
+        abstract = True
+        verbose_name = _('Спроможність та вільні місця')
+        verbose_name_plural = _('Наявність вільних місць у класах (п. 7 Порядку)')
+        ordering = ['grade_name']
+
+    def __str__(self):
+        return f"{self.grade_name}: вільних {self.available_slots}"
+
+    @property
+    def available_slots(self):
+        return max(0, self.total_capacity - self.enrolled_count)
+
+
+class ClassCapacity(AbstractClassCapacity):
+    class Meta(AbstractClassCapacity.Meta):
+        abstract = False
+
+
+class AbstractEnrolledStudent(models.Model):
+    """
+    ВАЖЛИВО: Дотримання Закону України «Про захист персональних даних».
+    Оприлюднюються виключно прізвища зарахованих дітей!
+    """
+    last_name = models.CharField(max_length=100, verbose_name=_('Прізвище зарахованої дитини (виключно прізвище)'))
+    enrollment_date = models.DateField(verbose_name=_('Дата зарахування'))
+    order_number = models.CharField(max_length=100, blank=True, verbose_name=_('Номер наказу про зарахування'))
+    is_lottery = models.BooleanField(default=False, verbose_name=_('Зараховано за результатами жеребкування'))
+
+    class Meta:
+        abstract = True
+        verbose_name = _('Зарахований учень (захист персональних даних)')
+        verbose_name_plural = _('Списки зарахованих учнів (прізвища)')
+
+    def __str__(self):
+        return f"{self.last_name}"
+
+
+class EnrolledStudent(AbstractEnrolledStudent):
+    grade = models.ForeignKey(ClassCapacity, on_delete=models.CASCADE, related_name='students', verbose_name=_('Клас'))
+
+    class Meta(AbstractEnrolledStudent.Meta):
+        abstract = False
+        ordering = ['grade', 'last_name']
+
+    def __str__(self):
+        return f"{self.last_name} ({self.grade.grade_name})"
+
+
+class AbstractAdmissionLottery(models.Model):
+    title = models.CharField(max_length=255, verbose_name=_('Тема оголошення жеребкування'))
+    target_grade = models.CharField(max_length=50, verbose_name=_('Клас для жеребкування'))
+    lottery_datetime = models.DateTimeField(verbose_name=_('Дата і час проведення жеребкування'))
+    location = models.CharField(max_length=255, verbose_name=_('Місце та спосіб проведення (актова зала, онлайн-трансляція)'))
+    available_places = models.PositiveIntegerField(verbose_name=_('Кількість вільних місць'))
+    candidates_count = models.PositiveIntegerField(verbose_name=_('Кількість дітей-претендентів'))
+    committee_order_doc = models.FileField(
+        upload_to='admissions/lottery/',
+        verbose_name=_('Наказ про утворення конкурсної комісії з 3 осіб')
+    )
+    is_completed = models.BooleanField(default=False, verbose_name=_('Жеребкування проведено'))
+
+    class Meta:
+        abstract = True
+        verbose_name = _('Жеребкування на вільні місця')
+        verbose_name_plural = _('Жеребкування на вільні місця')
+        ordering = ['-lottery_datetime']
+
+    def __str__(self):
+        return f"{self.title} ({self.target_grade})"
+
+
+class AdmissionLottery(AbstractAdmissionLottery):
+    class Meta(AbstractAdmissionLottery.Meta):
+        abstract = False

django_school_framework-0.2.2/apps/admissions/serializers.py

@@ -0,0 +1,28 @@
+from rest_framework import serializers
+from .models import ServiceTerritory, ClassCapacity, EnrolledStudent, AdmissionLottery
+
+class ServiceTerritorySerializer(serializers.ModelSerializer):
+    class Meta:
+        model = ServiceTerritory
+        fields = ['id', 'street_name', 'building_numbers', 'district', 'decision_doc']
+
+class EnrolledStudentSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = EnrolledStudent
+        fields = ['id', 'last_name', 'enrollment_date', 'order_number', 'is_lottery']
+
+class ClassCapacitySerializer(serializers.ModelSerializer):
+    available_slots = serializers.IntegerField(read_only=True)
+    students = EnrolledStudentSerializer(many=True, read_only=True)
+
+    class Meta:
+        model = ClassCapacity
+        fields = ['id', 'grade_name', 'total_capacity', 'enrolled_count', 'available_slots', 'updated_at', 'students']
+
+class AdmissionLotterySerializer(serializers.ModelSerializer):
+    class Meta:
+        model = AdmissionLottery
+        fields = [
+            'id', 'title', 'target_grade', 'lottery_datetime', 'location',
+            'available_places', 'candidates_count', 'committee_order_doc', 'is_completed'
+        ]

django_school_framework-0.2.2/apps/admissions/tests.py

@@ -0,0 +1,29 @@
+from django.test import TestCase
+from datetime import date
+from .models import ClassCapacity, EnrolledStudent
+
+class AdmissionsComplianceTests(TestCase):
+    def setUp(self):
+        self.capacity = ClassCapacity.objects.create(
+            grade_name='1-А',
+            total_capacity=30,
+            enrolled_count=28
+        )
+
+    def test_available_slots_calculation(self):
+        self.assertEqual(self.capacity.available_slots, 2)
+
+    def test_personal_data_protection(self):
+        """
+        Перевірка дотримання ЗУ «Про захист персональних даних»:
+        У списках оприлюднюються виключно прізвища здобувачів освіти.
+        """
+        student = EnrolledStudent.objects.create(
+            last_name='Коваленко',
+            grade=self.capacity,
+            enrollment_date=date(2026, 6, 1),
+            order_number='№ 12-У'
+        )
+        self.assertEqual(student.last_name, 'Коваленко')
+        self.assertFalse(hasattr(student, 'first_name'))
+        self.assertFalse(hasattr(student, 'passport_or_birth_cert'))

django_school_framework-0.2.2/apps/admissions/urls.py

@@ -0,0 +1,16 @@
+from django.urls import path, include
+from rest_framework.routers import DefaultRouter
+from .views import (
+    ServiceTerritoryViewSet, ClassCapacityViewSet,
+    EnrolledStudentViewSet, AdmissionLotteryViewSet
+)
+
+router = DefaultRouter()
+router.register(r'territory', ServiceTerritoryViewSet, basename='admissions-territory')
+router.register(r'capacity', ClassCapacityViewSet, basename='admissions-capacity')
+router.register(r'students', EnrolledStudentViewSet, basename='admissions-students')
+router.register(r'lottery', AdmissionLotteryViewSet, basename='admissions-lottery')
+
+urlpatterns = [
+    path('', include(router.urls)),
+]

django_school_framework-0.2.2/apps/admissions/views.py

@@ -0,0 +1,30 @@
+from rest_framework import viewsets, permissions, filters
+from .models import ServiceTerritory, ClassCapacity, EnrolledStudent, AdmissionLottery
+from .serializers import (
+    ServiceTerritorySerializer, ClassCapacitySerializer,
+    EnrolledStudentSerializer, AdmissionLotterySerializer
+)
+
+class ServiceTerritoryViewSet(viewsets.ReadOnlyModelViewSet):
+    queryset = ServiceTerritory.objects.all()
+    serializer_class = ServiceTerritorySerializer
+    permission_classes = [permissions.AllowAny]
+    filter_backends = [filters.SearchFilter]
+    search_fields = ['street_name', 'building_numbers']
+
+class ClassCapacityViewSet(viewsets.ReadOnlyModelViewSet):
+    queryset = ClassCapacity.objects.all()
+    serializer_class = ClassCapacitySerializer
+    permission_classes = [permissions.AllowAny]
+
+class EnrolledStudentViewSet(viewsets.ReadOnlyModelViewSet):
+    queryset = EnrolledStudent.objects.all().select_related('grade')
+    serializer_class = EnrolledStudentSerializer
+    permission_classes = [permissions.AllowAny]
+    filter_backends = [filters.SearchFilter]
+    search_fields = ['last_name']
+
+class AdmissionLotteryViewSet(viewsets.ReadOnlyModelViewSet):
+    queryset = AdmissionLottery.objects.all()
+    serializer_class = AdmissionLotterySerializer
+    permission_classes = [permissions.AllowAny]

django_school_framework-0.2.2/apps/core/admin.py

@@ -0,0 +1,17 @@
+from django.contrib import admin
+from .models import SchoolProfile, ThemeSettings
+
+class ThemeSettingsInline(admin.StackedInline):
+    model = ThemeSettings
+    can_delete = False
+    verbose_name = "Налаштування теми та кольорів сайту"
+
+@admin.register(SchoolProfile)
+class SchoolProfileAdmin(admin.ModelAdmin):
+    list_display = ('name', 'edrpou', 'founder', 'licensed_capacity', 'actual_students', 'updated_at')
+    search_fields = ('name', 'edrpou', 'founder')
+    inlines = [ThemeSettingsInline]
+
+@admin.register(ThemeSettings)
+class ThemeSettingsAdmin(admin.ModelAdmin):
+    list_display = ('school', 'primary_color', 'secondary_color', 'accent_color', 'font_family')

django_school_framework-0.2.2/apps/core/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+class CoreConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'apps.core'
+    verbose_name = 'Загальні відомості та налаштування школи'