Перейти до змісту

Встановлення фреймворку

PyPI version Downloads Supported Python

Фреймворк django-school-framework офіційно доступний у каталозі пакетів Python — PyPI. Ви можете встановити його за допомогою стандартного менеджера пакетів pip.

⚡ Офіційне встановлення через PyPI (Рекомендовано)

Створіть робочу директорію для вашого закладу освіти та активуйте віртуальне оточення:

mkdir my_school_project
cd my_school_project

# 1. Створення та активація віртуального оточення
python3 -m venv .venv
source .venv/bin/activate

# 2. Встановлення фреймворку через pip
pip install django-school-framework

mkdir my_school_project
cd my_school_project

# 1. Створення та активація віртуального оточення
python -m venv .venv
.venv\Scripts\Activate.ps1

# 2. Встановлення фреймворку через pip
pip install django-school-framework

Команда автоматично встановить усі необхідні залежності: * Django 5.2 (>=5.2,<5.3 у поточному вихідному коді) * djangorestframework (REST API) * drf-spectacular (OpenAPI 3.0 / Swagger UI) * django-cors-headers * django-filter * Pillow (обробка зображень та фотоальбомів) * Глобальну консольну утиліту school-admin

📦 Додаткові пакети (Extras)

Фреймворк підтримує розширені набори залежностей для різних баз даних та інструментів:

Підтримка MySQL / MariaDB

pip install "django-school-framework[mysql]"

Інструменти тестування для розробників

pip install "django-school-framework[dev]"

🔄 Оновлення до останньої версії

Щоб оновити встановлений пакет до найсвіжішої версії з усіма останніми змінами та виправленнями:

pip install --upgrade django-school-framework

Перевірити встановлену версію:

python -m pip show django-school-framework

🛠️ Встановлення для розробників (з вихідного коду)

Якщо ви бажаєте долучитися до розробки фреймворку, писати нові модулі або вносити правки у код:

git clone https://github.com/shadowlockck/framewrok-for-school.git
cd framewrok-for-school

# Створення ізольованого оточення
python3 -m venv venv
source venv/bin/activate

# Встановлення в режимі редагування (editable)
pip install -e backend

Усі зміни у файлах автоматично впливатимуть на роботу CLI без потреби повторного встановлення.

✅ Перевірка успішності встановлення

Після інсталяції перевірте працездатність CLI-утиліти:

school-admin --help

Ви повинні побачити список доступних команд: startproject, create-school, check-compliance, seed-data, create-frontend.

Тепер можна переходити до Швидкого старту за 5 хвилин!