Skip to content
Update Developer Guide authored by Brian's avatar Brian
...@@ -18,8 +18,11 @@ SCDV is developed in Python using [Qt for Python](https://wiki.qt.io/Qt_for_Pyth ...@@ -18,8 +18,11 @@ SCDV is developed in Python using [Qt for Python](https://wiki.qt.io/Qt_for_Pyth
As stated above, SCDV uses [Poetry][] to manage dependencies and requirements. See the `pyproject.toml` file in the repo for what python dependencies are being used in SCDV. During development, however, many changes may actually be done in [scdatatools][]. It's recommended to clone both projects, then use `pip install -e` the local version of scdatatools. As stated above, SCDV uses [Poetry][] to manage dependencies and requirements. See the `pyproject.toml` file in the repo for what python dependencies are being used in SCDV. During development, however, many changes may actually be done in [scdatatools][]. It's recommended to clone both projects, then use `pip install -e` the local version of scdatatools.
## Developer Quick Start ## Developer Quick Start
While there are many ways to configure your development environment, the following methods are known to work/repeatable.
### I know what I'm doing quickstart ### I know what I'm doing quickstart
...@@ -38,11 +41,74 @@ poetry install ...@@ -38,11 +41,74 @@ poetry install
poetry run python -m pip install -e ../../frameworks/scdatatools poetry run python -m pip install -e ../../frameworks/scdatatools
``` ```
#### Running ### Windows Development Guide
> All command snippets are assumed to be in Git Bash unless specifically stated otherwise
#### Dependencies
##### Git Bash
Install from https://git-scm.com/downloads.
##### pyenv-win
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
Install Python 3.9.2 with `pyenv-win`
```bash
pyenv install 3.9.2
```
##### poetry
[Install poetry](https://python-poetry.org/docs/#windows-powershell-install-instructions) using PowerShell:
```powershell
(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python -
```
### Clone
The recommend folder structure is created as follows
```bash
mkdir -p scmodding/{tools,frameworks}/
cd scmodding
git clone git@gitlab.com:scmodding/tools/scdv.git tools/scdv
git clone git@gitlab.com:scmodding/frameworks/scdatatools.git frameworks/scdatatools
```
### Initial Setup
In the `scmodding` folder created above:
```bash
# this will cause pyenv to automatically set the default python to 3.9.2 whenever you're within scmodding
pyenv local 3.9.2
cd tools/scdv
poetry install
poetry run python -m pip install -e ../../frameworks/scdatatools
```
## Running
From within the `scmodding/tools/scdv/` folder:
```bash ```bash
poetry run python -m scdv poetry run python -m scdv
``` ```
## PyCharm
###
[Poetry]: https://python-poetry.org/ [Poetry]: https://python-poetry.org/
[scdatatools]: https://gitlab.com/scmodding/frameworks/scdatatools [scdatatools]: https://gitlab.com/scmodding/frameworks/scdatatools
\ No newline at end of file