Merge branch 'main' of github_lpo:lpoaura/weatherlink2pg

lpoaura · May 22, 2024 · 67bca21 · 67bca21
2 parents faa00b4 + 112cb66
commit 67bca21
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 10 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -63,7 +63,7 @@ jobs:
           retention-days: 30
 
       - name: Setup Pages
-        uses: actions/configure-pages@v4
+        uses: actions/configure-pages@v5
         if: github.event_name == 'push' && (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main')
 
       - name: Upload artifact

diff --git a/docs/source/installation.md b/docs/source/installation.md
@@ -3,9 +3,49 @@
 ## Installation
 
 ```bash
+python3 venv weatherlink_venv
 pip install weatherlink2pg
 ```
 
 ## Usage
 
-Coming soon...
+Usage require some variable environment as mentionned in file `.env.sample`
+for weatherlink api authentication and database connection.
+
+### Full download
+
+Required as first launch
+
+```sh
+source weatherlink_env/bin/activate
+source <env file>
+weatherlink2pg full
+```
+
+### Update
+
+```sh
+source weatherlink_env/bin/activate
+source <env file>
+weatherlink2pg update
+```
+
+### crontask
+
+recommanded way to update data using cron tasks
+
+Create a script with the following code
+
+```bash
+#!/bin/bash
+
+SCRIPT_RELATIVE_DIR=$(dirname "${BASH_SOURCE[0]}")
+
+source $SCRIPT_RELATIVE_DIR/bin/activate
+
+set -a # automatically export all variables
+source  $SCRIPT_RELATIVE_DIR/.weatherlink2pg.env
+set +a
+
+weatherlink2pg update
+```
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -46,7 +46,7 @@ click = "^8.1.7"
 
 
 [tool.poetry.group.dev.dependencies]
-spyder-kernels = "==2.4.*"
+spyder-kernels = ">=2.4,<2.6"
 ipykernel = "^6.29.4"
 black = "^24.4.1"
 isort = "^5.13.2"