Readme s pipenv inštrukciami

README.md

@@ -7,80 +7,52 @@ git clone https://github.com/zdruzeniestrom/webstrom-backend
 cd webstrom-backend
 ```
 
-Vytvor a aktivuj prostredie pre python:
-
-Linux:
+Následne je potrebné si nainštalovať python package, na ktorých závisí naša stránka. To sa dá najľahšie dosiahnuť pomocou nástroja `pipenv`. Ten si môžeme buď nainštalovať pomocou package managera našej distribúcie alebo priamo cez `pip`:
 
 ```shell
-python3 -m venv <názov prostredia>
-source <názov prostredia>/bin/activate
-```
-
-Windows:
-
-```batch
-py -m venv <názov prostredia>
-call <názov prostredia>\Scripts\activate.bat
+pip install pipenv
 ```
 
-**Ak si prostredie pre python vytváraš v priečinku so stránkou, nezabudni pridať priečinok s prostredím do `.gitignore`**
-
-Nainštaluj potrebné balíky:
+Keď už máme `pipenv`, spustíme:
 
 ```shell
-pip install -r requirements.txt
-```
+pipenv sync --dev
 
-Pre production stačí
-
-```shell
-pip install -r prod-requirements.txt
+pipenv shell
 ```
 
-(bez linteru a formátovaču a podobne).
-
-**Package `python-magic` používa externé knižnice, zariaď, aby si ich mal nainštalované**
-
-**Dokumentácie**
-* [python-magic](https://pypi.org/project/python-magic/)
-
-Vytvor a naplň databázu:
+V tomto bode stačí už len vytvoriť databázu a spustiť si lokálny server:
 
 ```shell
 python manage.py restoredb
+python manage.py runserver
 ```
 
-Spusti lokálny vývojový server:
+V prípade, že nechceme použiť `pipenv`, môžeme použiť `venv` zo štandardnej knižnice pythonu:
 
 ```shell
-python manage.py runserver
-```
+python -m venv .venv
 
-# Nastavenia linteru a formátovaču
+source .venv/bin/activate
 
-## Linter
-
-VSCode python extension podporuje viacero linterov, medzi nimi aj `pylint`. Aby si ho mohol používať, treba VSCodu povedať, aby pri spustení linteru načítal djangový plugin, teda do workspace settings (`${workspaceFolder}/.vscode/settings.json`) treba pridať
+pip install -r requirements.txt
 
-```json
-"python.linting.pylintArgs": [
-    "--load-plugins",
-    "pylint_django"
-]
+python manage.py restoredb
+python manage.py runserver
 ```
 
-Teraz ak nemáš nejak veľmi zle nastavený globálny config, mal by ťa linter začať šikanovať tým, že ti bude podfarbovať kusy kódu a pridávať položky do panelu `PROBLEMS`.
+V prípade, že pracujeme na Windowse, musíme si ešte nainštalovať package `python-magic-bin`:
 
-## Formátovač
+```shell
+pip install python-magic-bin
+```
 
-Nainštaluj si (opäť, vo vnútri svojho virtual environmentu) package `autopep8`. Okrem toho potrebuješ zapnúť `editor.formatOnSave` (defaultne je vypnuté), buď v globálnom configu alebo len lokálne vo projekte.Odporúčam globálne - pridaj do svojho `settings.json` suboru (VSCode) tento riadok
+V každom prípade by sme mali vytvorené prostredie nastaviť ako python interpreter vo vscode projekte cez `> Python: Select Interpreter`.
 
-```
-"editor.formatOnSave": true,
-```
 # Migrácia starej databázy
 
 Pre načítanie dát zo starej stránky si najrpv potrebuješ stiahnuť starú databázu k sebe. Potom vybrané dáta z nej načítaš pomocou príkazu:
-```
-python manage.py loadb <cesta k databázi>
+
+```shell
+python manage.py load_db <cesta k databázi>
 ```