feat: update dependencies + README (#3)

.github/workflows/tests.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11']
 
     steps:
     - uses: actions/checkout@v3

README.md

@@ -18,76 +18,99 @@ learning systems in a production perspective.
 
 # Index
 
-1. [Recommended prerequisites](#prerequisites)
-2. [Installation & Setup](#installation-setup)
-3. [Usage](#usage)
-
-# Recommended prerequisites
-
-## Git
-
+1. [Prerequisites](#prerequisites)
+   1. [Recommended software](#recommended-software)
+   2. [Install environment](#install-environment)
+   3. [Set up PostgreSQL database for Airflow](#set-up-postgresql-database-for-airflow)
+   4. [Set up Airflow](#set-up-airflow)
+   5. [Set up MLflow](#set-up-mlflow)
+2. [Usage (#FIXME)](#usage-fixme)
+
+# Prerequisites
+
+`mylearn` leverages [poetry](https://github.com/python-poetry/poetry) and [poethepoet](https://github.com/nat-n/poethepoet)
+to make its installation and setup surprisingly simple. We recommend install and use `mylearn` under a Linux environment
+and strictly follow indications provided in this section to avoid any struggle with `mylearn` installation.
+
+## Recommended software
+
+- [Git](https://git-scm.com/downloads)
+- [PostgreSQL](https://www.postgresql.org/download/)
+- [pgAdmin](https://www.pgadmin.org/download/) (optional)
+- [pyenv](https://github.com/pyenv/pyenv/wiki#suggested-build-environment)
+    ```
+    # Install binary dependencies and build tools
+    sudo apt update
+    sudo apt install build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev curl libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev
+
+    # Install pyenv
+    curl https://pyenv.run | bash
+    echo 'export PATH="$HOME/.pyenv/bin:$PATH"' >> ~/.bashrc
+    echo 'eval "$(pyenv init -)"' >> ~/.bashrc
+    echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.bashrc
+    source ~/.bashrc
+    
+    # Install a Python version and set it as default:
+    pyenv install 3.11.6
+    pyenv global 3.11.6
+    ```
+- [poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
+    ```
+    curl -sSL https://install.python-poetry.org | python3 -
+    echo 'export PATH="~/.local/bin:$PATH"' >> ~/.bashrc
+    ```
+
+Once poetry is installed, close and reopen your terminal. We recommended configure `poetry` to install requirements within a `virtualenv` located at the project root level, although not required.
 ```commandline
-sudo apt-get install git
+poetry config virtualenvs.in-project true
 ```
 
-## pyenv
+## Install environment
 
-Install [binary dependencies and build tools](https://github.com/pyenv/pyenv/wiki#suggested-build-environment):
-```commandline
-sudo apt update
-sudo apt install build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev curl libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev
-```
-
-Install pyenv:
+Installation is run with:
 ```commandline
-curl https://pyenv.run | bash
-echo 'export PATH="$HOME/.pyenv/bin:$PATH"' >> ~/.bashrc
-echo 'eval "$(pyenv init -)"' >> ~/.bashrc
-echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.bashrc
-source ~/.bashrc
+poetry install
 ```
 
-Install a Python version and set it as default:
+Should you install from the `requirements.txt` file instead of the `poetry.lock` file:
 ```commandline
-pyenv install 3.11.2
-pyenv global 3.11.2
+pyenv shell 3.11.6
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
 ```
 
-## poetry
+## Set up PostgreSQL database for Airflow
 
-```commandline
-curl -sSL https://install.python-poetry.org | python3 -
-echo 'export PATH="~/.local/bin:$PATH"' >> ~/.bashrc
+Open PostgreSQL command line:
+```
+sudo -i -u postgres
+psql
 ```
 
-# Installation & Setup
-
-mylearn leverages [poetry](https://github.com/python-poetry/poetry) and [poethepoet](https://github.com/nat-n/poethepoet)
-to make its installation and setup surprisingly simple.
+Create `airflow` database with `airflow` user and `airflow` password:
+```
+CREATE DATABASE airflow;
+CREATE USER airflow WITH PASSWORD 'airflow';
+GRANT ALL PRIVILEGES ON DATABASE airflow TO airflow;
+ALTER DATABASE airflow OWNER TO airflow;
+ALTER ROLE airflow WITH CREATEDB;
+```
 
-## Installation
+## Set up pgAdmin (optional)
 
-It is recommended to install requirements within a `virtualenv` located at the project root level, although not required.
-```commandline
-poetry config virtualenvs.in-project true
-```
+Open pgAdmin, right-click on "Servers" at the top-left and click on "Register > Server".
 
-Installation is run with:
-```commandline
-poetry install
-```
+Then, provide your desired "Name" in the "General" tab, and the following information in the "Connection" tab where:
+- "Port" matches the value in the `AIRFLOW__DATABASE__SQL_ALCHEMY_CONN` variable in `pyproject.toml`
+- "Maintenance database", "Username" and "Password" match the names defined in the previous subsection
+- "Save password" is activated
 
-Should you install from the `requirements.txt` file instead of the `poetry.lock` file:
-```commandline
-pyenv shell 3.11.2
-python -m venv .venv
-source .venv/bin/activate
-pip install -r requirements.txt
-```
+![pgadmin.png](docs/assets/pgadmin.png)
 
-## Airflow Setup
+## Set up Airflow
 
-Airflow setup is initialized via a `poe` command
+Airflow is initialized with a single `poe` command
 ```commandline
 poe airflow-init
 ```
@@ -98,22 +121,22 @@ poe airflow-scheduler
 poe airflow-webserver
 ```
 
-Airflow UI can be opened at [localhost](0.0.0.0:8080) (port 8080), and you can login with username and password `admin`.
+Airflow UI can be opened at [localhost:8080](http://localhost:8080), and you can login with username and password `admin`.
 
 If you want to clean your Airflow setup before rerunning `poe airflow-init`, you need to kill Airflow Scheduler &
 Webserver and run
 ```commandline
 poe airflow-clean
 ```
 
-## MLflow Setup
+## Set up MLflow (#FIXME)
 
-MLflow UI can be opened at [localhost](0.0.0.0:5000) (port 5000) after execution of the following command:
+MLflow UI can be opened at [localhost:5000](http://localhost:5000) after execution of the following command:
 ```commandline
 poe mlflow-ui
 ```
 
-# Usage
+# Usage (#FIXME)
 
 ## MLflow Pipelines Regression Template