Перегляд вихідного коду сторінки Розгортання системи K2 ERP Python для розробників

'''Розгортання системи K2 ERP Python для розробників''' — інструкція з локального розгортання робочого проєкту [[K2 Cloud ERP|K2 ERP]], підключення розробника, налаштування PyCharm, Git, компонентів, сервера оновлень і процесу публікації нових версій компонент.

== Розгортання локального робочого проєкту ==
Розгортання локально робочого проекту K2 ERP та підключення до нього розробника

== 1. Копіювання існуючого проекту по ftp, перший запуск ==

* копіюєм з віддаленого сервера існуючий проект по ftp

* переходимо в каталог /K2CloudERP і запускаємо файл first_run для налаштування параметрів віртуального середовища в поточному локальному розташуванні командою:
<pre>
bash first_run.sh - для Linux
./first_run.bat - для Windows
</pre>

* переходимо в файл налаштувань /K2CloudERP/cfg/k2/k2/k2cfg.py і змінюємо там domain_protocol з https на http

* запускаємо додаток:
<pre>
bash run.sh - для Linux
./run.bat - для Windows
</pre>

== 2. Встановлення, середовища розробки Pycharm та відкриття проекту: ==

=== для Linux ===

* встановлення через snap
<pre>
sudo rm /etc/apt/preferences.d/nosnap.pref
sudo apt update
sudo apt install snapd
sudo snap install pycharm-community --classic
pycharm-community
</pre>

* встановлення через завантаження архіву з сайту

https://www.jetbrains.com/pycharm/download/?section=linux

розпаковуємо архів, переходимо в папку bin і запускаємо<pre>
./pycharm.sh
</pre>якщо отримали помилку встановлюємо JRE/JDK командами:<pre>
sudo apt update
sudo apt install default-jdk
</pre>

=== для Windows ===

=== Завантаження архіву ===
завантажуємо архів https://www.jetbrains.com/pycharm/download/?section=windows

розпаковуємо архів, запускаємо файл встановленя і встановлюємо згідно інструкцій

* відкриваємо середовище розробки Pycharm,

* відкриваємо поточний завантажений проект та налаштовуємо змінне середовище для поточного проекту:

в правому нижньому куті вибираємо Python Interpreter --> Add new Interpreter -->

у полі locations додаємо шлях до поточної папки venv

у полі Base Interpreter додаємо шлях до поточного виконуваного Python файлу (Пр: ../K2CloudERP/venv/bin.python3.12.exe)

* запускаємо проект в дебаг режимі (кнопка в правому верхньому куті)

* запускаємо проект з консолі Pycharm командою:
<pre>
bash run.sh - для Linux
./run.bat - для Windows
</pre>

* активація віртуального середовища вручну
<pre>
source venv/bin/activate - для Linux
.\venv\Scripts\activate - для Windows
</pre>

== 3. Встановлення та налаштування git ==

* встановлення

=== для Linux ===
<pre>
sudo apt update
sudo apt install git
</pre>

=== для Windows ===
завантажуємо архів https://git-scm.com/downloads/win розпаковуємо архів, запускаємо файл встановленя і встановлюємо згідно інструкцій

* налалштування git

=== налаштування користувача ===
<pre>
git config --global user.name "Ваше Ім'я"
git config --global user.email "ваша_електронна_пошта@example.com"
</pre>

=== авторизація з допомогою логіна і пароля ===

=== авторизація через ssh ===

=== Налаштування SSH ключа ===
<pre>
ssh-keygen -t rsa -b 4096 -C "ваша_електронна_пошта@example.com"
eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_rsa
cat ~/.ssh/id_rsa.pub
</pre>копіюєм отриманий ключ і вставляємо у віддалений репозиторій

== 4. підключаємо віддалений репозиторій git для певної компоненти або списку компонент ==
для списку компонент (скрипт auto_update)
 копіюєм каталог із скриптом і вставляємо в корінь проекту на рівні з виконуваним файлом app.py https://git.corp2.eu/k2erp/python/k2/base/client/auto_update
відкриваємо проект в консолі і переходимо в каталог auto_update<pre>
cd auto_update
</pre>відкриваємо файл settings.py і додаємо в словник ключі з потрібними компонентами (повний список в файлі settings_example.py)

* виконуємо в консолі команду, для клонування актуальних версій компонент і перейменовування каталогів поточних версій компонент
<pre>
python git_cmd.py clone
</pre>

=== для одної компоненти вручну ===

* переходимо в папку необхідної компоненти, наприклад k2site
<pre>
cd components/k2site
</pre>

* ініціалізуєм git в поточній директорії
<pre>
git init
git checkout -b main (створюємо локальну гілку main і перемикаємось на неї)
git checkout master (переключаємось на іншу локальну гілку)
git remote add origin http://git.corp2.eu/k2erp/python/k2/base/site/k2site.git
git remote -v (перевірка)
</pre>

* отримуємо дані з віддаленого репозиторію але не змінюємо поточну робочу гілку
<pre>
git fetch origin
</pre>

* отримуємо дані з віддаленого репозиторію з віддаленого репозиторію та автоматично об'єднує їх з поточною локальною гілкою.
<pre>
git pull origin main
</pre>

* перевіряємо зміни локально скопійованої копії проекту з віддаленим репозиторієм
<pre>
git status
</pre>

== 5. Комміт змін на віддалений репозиторій git ==

=== автоматично (скрипт auto_update) ===
відкриваємо проект в консолі і переходимо в каталог auto_update<pre>
cd auto_update
</pre>клонуємо компоненти з віддаленого сервера<pre>
python git_cmd.py clone
</pre>перевірка статусу
 python git_cmd.py status
коміт змін<pre>
python git_cmd.py commit
</pre>отримуємо зміни з віддаленого сервера<pre>
python git_cmd.py pull
</pre>пушимо зміни на віддалений репозиторій<pre>
python git_cmd.py push
</pre>

=== вручну ===

* після внесених в коді змін перевіряємо їх командою
<pre>
git status
</pre>

* додаємо зміни командою
<pre>
git add .
</pre>

* комітимо зміни:
<pre>
git commit -m "Назва комміту"
</pre>

* пушимо зміни на віддалений репозиторій
<pre>
git push
</pre>

* при подальшій роботі отримуємо зміни з віддаленого репозиторію командою
<pre>
git pull
</pre>

== 6. Налаштування завантаження компонент на сервер оновлення ==

* відкриваємо папку builder/config

* в файлі component-list.txt додаємо список компонент, які будемо завантажувати на сервер оновлення, кожна компонента з нового рядка
<pre>
components/k2update
components/k2adm
components/k2site
</pre>

* в папці ignore створюємо файл з назвою компоненти і додаємо файли і папки, які не потрібно завантажувати на сервер оновлення

( приклад:<pre>
k2site.txt
__pycache__
.gitignore
.git
ej2.min.js
</pre>)

* в файлі token.txt додаємо токен доступу до сервера оновлення

== 7. Завантаження нової версії компоненти в систему оновлення ==
Для створення нової версії компоненти (stable або beta (testing) версії):

* змінюємо версію в файлі setup.py в корні каталогу компоненти (рядок 5 поле version, наприклад version=2.0.4.43, version_type='stable' (testing))

* додаємо опис змін в в файлі history.txt в корні каталогу компоненти (1 рядок, наприклад 2.0.4.43 - додавання додаткового поля в форму реєстрації)

* переходимо в корінь додатку, на рівні з виконуваним файлом app.py:
<pre>
cd k2
</pre>

* завантажуємо додані в файлі builder/config/component-list.txt компоненти командою:
<pre>
python k2update_push.py
</pre>

== 8. Оновлюємо змінені версії компонент на тестових доменах deb1-deb3 та тестуємо функціонал. ==

== Контрольний чек-лист розгортання ==

# Проєкт скопійовано з віддаленого сервера по FTP.
# Виконано <code>first_run.sh</code> або <code>first_run.bat</code>.
# У файлі <code>/K2CloudERP/cfg/k2/k2/k2cfg.py</code> для локального запуску змінено <code>domain_protocol</code> з <code>https</code> на <code>http</code>.
# Проєкт запускається через <code>run.sh</code> або <code>run.bat</code>.
# У PyCharm налаштовано Python Interpreter на локальне віртуальне середовище <code>venv</code>.
# Встановлено та налаштовано Git.
# Підключено віддалений репозиторій потрібної компоненти або список компонент через <code>auto_update</code>.
# Перевірено <code>git status</code>, <code>git pull</code>, <code>git push</code>.
# Налаштовано <code>builder/config/component-list.txt</code>, <code>ignore</code> та <code>token.txt</code> для сервера оновлень.
# Оновлено версію компоненти в <code>setup.py</code> і опис змін у <code>history.txt</code>.
# Виконано <code>python k2update_push.py</code>.
# Оновлено компоненти на тестових доменах <code>deb1</code>–<code>deb3</code> та перевірено функціонал.

== Див. також ==

* [[K2 Cloud ERP|K2 ERP]]
* [[K2 Cloud ERP Python для розробників|K2 ERP Python для розробників]]
* [[Python]]
* [[PyCharm]]
* [[Git]]
* [[Розгортання системи K2 Cloud ERP PHP|Розгортання системи K2 ERP PHP]]