Налаштування середовища розробки¶
Щоб долучитися до BeeWare Docs Tools, вам потрібно налаштувати середовище розробки.
Необхідні умови¶
Вам потрібно буде встановити такі необхідні компоненти.
BeeWare Docs Tools вимагає Python 3.10+. Вам також знадобиться засіб для управління віртуальними середовищами (наприклад, venv).
Ви можете перевірити версію Python, яку у вас встановлено, виконавши наступну команду:
Python 3.8.10 (за замовчуванням, 10 липня 2020 р., 16:00:00)
Якщо у вас встановлено кілька версій Python, можливо, доведеться замінити python3 на конкретний номер версії (наприклад, python3.13)
Ми рекомендуємо уникати нещодавно випущених версій Python (тобто версій із мікроверсією «.0» або «.1», наприклад, 3.14.0). Це пов’язано з тим, що інструменти, необхідні для підтримки Python у macOS, часто випускаються із затримкою і зазвичай недоступні для нещодавно випущених стабільних версій Python.
BeeWare Docs Tools вимагає Python 3.10+. Вам також знадобиться засіб для управління віртуальними середовищами (наприклад, venv).
Ви можете перевірити версію Python, яку у вас встановлено, виконавши наступну команду:
Python 3.8.10 (за замовчуванням, 10 липня 2020 р., 16:00:00)
Якщо у вас встановлено кілька версій Python, можливо, доведеться замінити python3 на конкретний номер версії (наприклад, python3.13)
Ми рекомендуємо уникати нещодавно випущених версій Python (тобто версій із мікроверсією «.0» або «.1», наприклад, 3.14.0). Це пов’язано з тим, що інструменти, необхідні для підтримки Python у Linux, часто випускаються із запізненням і зазвичай недоступні для нещодавно випущених стабільних версій Python.
BeeWare Docs Tools вимагає Python 3.10+. Вам також знадобиться засіб для управління віртуальними середовищами (наприклад, venv).
Ви можете перевірити версію Python, яку у вас встановлено, виконавши наступну команду:
C:\...>py -3 --version
Якщо у вас встановлено кілька версій Python, можливо, вам доведеться замінити -3 на конкретний номер версії (наприклад, -python3.13)
Ми рекомендуємо уникати нещодавно випущених версій Python (тобто версій із мікроверсією «.0» або «.1», наприклад, 3.14.0). Це пов’язано з тим, що інструменти, необхідні для підтримки Python у Windows, часто випускаються із запізненням і зазвичай недоступні для нещодавно випущених стабільних версій Python.
Налаштуйте своє середовище розробки¶
Рекомендований спосіб налаштування середовища розробки для BeeWare Docs Tools полягає у використанні віртуального середовища, а потім — у встановленні версії BeeWare Docs Tools для розробки та її залежностей.
Створити клон репозиторію BeeWare Docs Tools¶
Далі перейдіть на BeeWare Docs Tools сторінку на GitHub і, якщо ви цього ще не зробили, створіть форк репозиторію у своєму обліковому записі. Далі натисніть кнопку «<> Code» у вашому форку. Якщо на вашому комп’ютері встановлено настільну програму GitHub, ви можете вибрати «Open with GitHub Desktop»; в іншому випадку скопіюйте надану HTTPS-адресу та використовуйте її для клонування репозиторію на свій комп’ютер за допомогою командного рядка:
Створіть форк репозиторію BeeWare Docs Tools, а потім:
$ git clone https://github.com/<ваше ім’я користувача>/beeware-docs-tools.git
$ cd beeware-docs-tools
(вставте своє ім'я користувача на GitHub)
Створіть форк репозиторію BeeWare Docs Tools, а потім:
$ git clone https://github.com/<ваше ім’я користувача>/beeware-docs-tools.git
$ cd beeware-docs-tools
(вставте своє ім'я користувача на GitHub)
Створіть форк репозиторію BeeWare Docs Tools, а потім:
C:\...>git clone https://github.com/<ваше ім'я користувача>/beeware-docs-tools.git
C:\...>cd beeware-docs-tools
(вставте своє ім'я користувача на GitHub)
Налаштувати вихідний репозиторій¶
Після клонування вашого форку додайте репозиторій BeeWare як віддалений upstream. Це забезпечить вашому локальному клону посилання на оригінальний репозиторій, що спростить синхронізацію оновлень у майбутньому.
Вам також знадобляться теги з upstream, щоб такі інструменти, як Toga та Briefcase, могли правильно визначати номери версій:
$ git remote add upstream https://github.com/beeware/beeware-docs-tools.git
$ git fetch --tags upstream
$ git remote add upstream https://github.com/beeware/beeware-docs-tools.git
$ git fetch --tags upstream
C:\...>git remote add upstream https://github.com/beeware/beeware-docs-tools.git
C:\...>git fetch --tags upstream
Якщо ви хочете, щоб у вашому форку також були ці теги, ви можете їх відправити:
$ git push --tags
Це може стати в нагоді, якщо ви згодом створите новий клон і захочете, щоб теги були доступні з вашого форку.
Створити віртуальне середовище¶
Щоб налаштувати віртуальне середовище та оновити pip, виконайте наступну команду:
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
C:\...>py -3 -m venv .venv
C:\...>.venv\Scripts\activate
(.venv) $ python -m pip install -U pip
Тепер перед вашим запитом має стояти префікс (.venv).
Встановити BeeWare Docs Tools¶
Тепер, коли у вас є вихідний код, ви можете виконати інсталяцію з можливістю редагування BeeWare Docs Tools у своєму середовищі розробки. Виконайте таку команду:
(.venv) $ python -m pip install -U -e . --group dev
(.venv) $ python -m pip install -U -e . --group dev
(.venv) C:\...>python -m pip install -U -e . --group dev
Увімкнути pre-commit¶
BeeWare Docs Tools використовує інструмент під назвою pre-commit для виявлення простих проблем та стандартизації форматування коду. Це здійснюється шляхом встановлення git-хука, який автоматично запускає низку лінтерів коду перед фінальним підтвердженням будь-якого git-коміту. Щоб увімкнути pre-commit, виконайте:
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) C:\...>pre-commit install
pre-commit installed at .git/hooks/pre-commit
Тепер ви готові приступити до розробки BeeWare Docs Tools!