feat: notebook for dialog-flow-analysis [MOV-3695] (#2)

.env.example

@@ -0,0 +1,22 @@
+###### Moveo Config #####
+MOVEO_API_KEY = "***"
+MOVEO_ACCOUNT_ID = "***"
+##################
+
+##### Zendesk Config #########
+ZENDESK_SUBDOMAIN = "***"
+# generate one by following https://support.zendesk.com/hc/en-us/articles/4408889192858-Managing-access-to-the-Zendesk-API#topic_tcb_fk1_2yb
+ZENDESK_API_TOKEN = "***"
+ZENDESK_USERNAME = "***"
+ZENDESK_API_TIMEOUT = "8000"
+##################
+
+###### Data visualization Config #####
+RATING_MIN = "0"
+RATING_MAX = "10"
+# Detractors: {RATING_MIN} - {DETRACTORS_UPPER_LIMIT}
+DETRACTORS_UPPER_LIMIT = "3"
+# Neutrals: {DETRACTORS_UPPER_LIMIT + 1} - {PROMOTERS_LOWER_LIMIT - 1}
+PROMOTERS_LOWER_LIMIT = "7"
+# Promoters: {PROMOTERS_LOWER_LIMIT} - {RATING_MAX}
+##################

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203, E402

.github/workflows/main.yaml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: make install-dev
+
+      - name: Install nbstripout
+        run: pip install nbstripout
+
+      - name: Remove notebook outputs
+        run: nbstripout --install
+
+      - name: Run formatting
+        run: make format
+
+      - name: Run linting
+        run: make lint

.gitignore

@@ -158,3 +158,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# Data directory
+data/