Development

.env.example

@@ -0,0 +1,2 @@
+VISION_API_USERNAME=
+VISION_API_PASSWORD=

.gitignore

@@ -1,4 +1,6 @@
 # Data files ignore rules are on data/.gitignore
+**/**/test.py
+test.py
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    - id: check-added-large-files # prevents adding large files
+    - id: detect-private-key # detects private keys
+    - id: fix-byte-order-marker # fixes BOM
+    - id: fix-encoding-pragma # fixes encoding pragma
+    - id: no-commit-to-branch # prevents committing to protected branches
+    - id: trailing-whitespace # prevents trailing whitespace
+
+-   repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+    -   id: black
+        language_version: python3.10
+
+-   repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+    - id: isort
+
+-   repo: https://github.com/PyCQA/flake8
+    rev: 6.0.0
+    hooks:
+    - id: flake8

README.md

@@ -1 +1,10 @@
 # Detecção de alagamentos
+
+## Develop
+
+
+`poetry install --no-root`
+
+Add .env vars missing from .env.example.
+
+`export POETRY_DOTENV_LOCATION=.env && streamlit run app/📣\ Home.py`