Skip to content
Update Developer Guide - Updated Python Version, Updated to include new poetry install method authored by SirPiggles's avatar SirPiggles
......@@ -22,7 +22,7 @@ StarFab is developed in Python using [Qt for Python](https://wiki.qt.io/Qt_for_P
## Core Guidelines
* Python [3.9.2](https://www.python.org/downloads/release/python-392/)
* Python [3.10.2](https://www.python.org/downloads/release/python-3102/)
* [Black](https://black.readthedocs.io/en/stable/) for code style/formatting
* Dependencies managed by [Poetry](https://python-poetry.org/)
* Release packages built with [briefcase](https://beeware.org/project/projects/tools/briefcase/)
......@@ -70,10 +70,10 @@ Install from [https://git-scm.com/downloads](https://git-scm.com/downloads).
pyenv-win provides an easy way to manage multiple Python versions on Windows. The easiest/preferred method is to install using [chocolatey](https://chocolatey.org/install). Follow the instructions here: [https://pyenv-win.github.io/pyenv-win/#installation](https://pyenv-win.github.io/pyenv-win/#installation)
* Install Python 3.9.2 with `pyenv-win`
* Install Python 3.10.2 with `pyenv-win`
```shell
pyenv install 3.9.2
pyenv install 3.10.2
```
##### poetry
......@@ -81,7 +81,7 @@ pyenv install 3.9.2
[Install poetry](https://python-poetry.org/docs/#windows-powershell-install-instructions):
```shell
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
curl -sSL https://install.python-poetry.org | python3 -
```
#### Linux/OSX
......@@ -90,10 +90,10 @@ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poet
pyenv provides an easy way to manage multiple Python versions on Linux/OSX. Set it up by following the instructions here [https://github.com/pyenv/pyenv-installer](https://github.com/pyenv/pyenv-installer)
* Install Python 3.9.2 with `pyenv`
* Install Python 3.10.2 with `pyenv`
```shell
pyenv install 3.9.2
pyenv install 3.10.2
```
> Every distro is different. If pyenv fails to build python, check [https://github.com/pyenv/pyenv/wiki#suggested-build-environment](https://github.com/pyenv/pyenv/wiki#suggested-build-environment)
......@@ -103,7 +103,7 @@ pyenv install 3.9.2
[Install poetry](https://python-poetry.org/docs/#osx--linux--bashonwindows-install-instructions):
```shell
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
curl -sSL https://install.python-poetry.org | python3 -
```
### Cloning
......@@ -125,8 +125,8 @@ git clone git@gitlab.com:scmodding/frameworks/scdatatools.git frameworks/scdatat
In the `scmodding` folder created above:
```shell
# this will cause pyenv to automatically set the default python to 3.9.2 whenever you're within scmodding
pyenv local 3.9.2
# this will cause pyenv to automatically set the default python to 3.10.2 whenever you're within scmodding
pyenv local 3.10.2
cd tools/starfab
poetry install
......
......