Konfiguracja środowiska programistycznego¶
Aby wnieść swój wkład do BeeWare Docs Tools, musisz skonfigurować środowisko programistyczne.
Wymagania wstępne¶
Należy zainstalować następujące wymagania wstępne.
BeeWare Docs Tools wymaga Python 3.10+. Potrzebna będzie
również metoda zarządzania środowiskami wirtualnymi (np. venv).
Możesz sprawdzić wersję zainstalowanego języka Python, uruchamiając:
Python 3.8.10 (wersja domyślna, 20 lipca 2020 r., godz. 16:16:00)
Jeśli masz zainstalowanych więcej niż jedną wersję Pythona, może być konieczne
zastąpienie python3 konkretnym numerem wersji (np. python3.13)
Zalecamy unikanie najnowszych wersji Pythona (tj. wersji z numerem mikroversji „.0” lub „.1”, np. 3.14.0). Wynika to z faktu, że narzędzia niezbędne do obsługi Pythona w systemie macOS często nie są dostępne dla najnowszych stabilnych wersji Pythona.
BeeWare Docs Tools wymaga Python 3.10+. Potrzebna będzie
również metoda zarządzania środowiskami wirtualnymi (np. venv).
Możesz sprawdzić wersję zainstalowanego języka Python, uruchamiając:
Python 3.8.10 (wersja domyślna, 20 lipca 2020 r., godz. 16:16:00)
Jeśli masz zainstalowanych więcej niż jedną wersję Pythona, może być konieczne
zastąpienie python3 konkretnym numerem wersji (np. python3.13)
Zalecamy unikanie najnowszych wersji Pythona (tj. wersji o numerze mikroversji „.0” lub „.1”, np. 3.14.0). Wynika to z faktu, że narzędzia niezbędne do obsługi Pythona w systemie Linux często nie są dostępne dla najnowszych stabilnych wersji Pythona.
BeeWare Docs Tools wymaga Python 3.10+. Potrzebna będzie
również metoda zarządzania środowiskami wirtualnymi (np. venv).
Możesz sprawdzić wersję zainstalowanego języka Python, uruchamiając:
C:\...>py -3 --version
Jeśli masz zainstalowanych więcej niż jedną wersję Pythona, może być konieczne
zastąpienie -3 konkretnym numerem wersji (np. -python3.13)
Zalecamy unikanie najnowszych wersji Pythona (tj. wersji z numerem mikroversji „.0” lub „.1”, np. 3.14.0). Wynika to z faktu, że narzędzia niezbędne do obsługi Pythona w systemie Windows często nie są dostępne dla najnowszych stabilnych wersji Pythona.
Skonfiguruj swoje środowisko programistyczne¶
Zalecanym sposobem skonfigurowania środowiska programistycznego dla BeeWare Docs Tools jest użycie środowiska wirtualnego, a następnie zainstalowanie wersji programistycznej BeeWare Docs Tools i jej zależności.
Sklonuj repozytorium BeeWare Docs Tools¶
Następnie przejdź do strony BeeWare Docs Tools na GitHubie, a jeśli jeszcze tego nie zrobiłeś, utwórz fork repozytorium na swoim koncie. Następnie kliknij przycisk „<> Kod” na swoim forku. Jeśli masz zainstalowaną aplikację GitHub Desktop na swoim komputerze, możesz wybrać opcję „Otwórz za pomocą GitHub Desktop”; w przeciwnym razie skopiuj podany adres URL HTTPS i użyj go do sklonowania repozytorium na swój komputer za pomocą wiersza poleceń:
Sforkuj repozytorium BeeWare Docs Tools, a następnie:
$ git clone https://github.com/<twoja nazwa użytkownika>/beeware-docs-tools.git
(zastępując swoją nazwę użytkownika GitHub)
Sforkuj repozytorium BeeWare Docs Tools, a następnie:
$ git clone https://github.com/<twoja nazwa użytkownika>/beeware-docs-tools.git
(zastępując swoją nazwę użytkownika GitHub)
Sforkuj repozytorium BeeWare Docs Tools, a następnie:
C:\...>git clone https://github.com/<twoja nazwa użytkownika>/beeware-docs-tools.git
(zastępując swoją nazwę użytkownika GitHub)
Ustaw repozytorium upstream¶
Po sklonowaniu swojego forka dodaj repozytorium BeeWare jako zdalne upstream .
Dzięki temu lokalna kopia będzie miała odniesienie do oryginalnego repozytorium,
co ułatwi synchronizację aktualizacji w miarę upływu czasu.
Będziesz również potrzebować tagów z upstream, aby narzędzia takie jak Toga i
Briefcase mogły rozpoznać dokładne numery wersji:
$ 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
Jeśli chcesz, aby Twój fork również zawierał te tagi, możesz je przesłać:
$ git push --tags
Może to być przydatne, jeśli później utworzysz nową kopię i chcesz, aby tagi były dostępne z Twojego forka.
Stwórz środowisko wirtualne¶
Aby skonfigurować środowisko wirtualne i zaktualizować pip, uruchom:
$ cd beeware-docs-tools
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
$ cd beeware-docs-tools
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
C:\...>cd beeware-docs-tools
C:\...>py -3 -m venv .venv
C:\...>.venv\Scripts\activate
(.venv) $ python -m pip install -U pip
Twoje polecenie powinno teraz mieć przed sobą prefiks (.venv).
Zainstaluj BeeWare Docs Tools¶
Teraz, gdy masz już kod źródłowy, możesz wykonać edytowalną instalację BeeWare Docs Tools w swoim środowisku programistycznym. Uruchom następujące polecenie:
(.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
Włącz pre-commit¶
BeeWare Docs Tools wykorzystuje narzędzie o nazwie pre-commit, które służy do identyfikowania prostych problemów i standaryzacji formatowania kodu. Odbywa się to poprzez zainstalowanie haka git, który automatycznie uruchamia serię linterów kodu przed sfinalizowaniem każdego zatwierdzenia git. Aby włączyć pre-commit, uruchom:
(.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
Teraz jesteś gotowy, aby rozpocząć hakowanie BeeWare Docs Tools!