Merge pull request #869 from NASA-IMPACT/dev

Dev to main

.env_sample

@@ -0,0 +1,18 @@
+CELERY_BROKER_URL=""
+CELERY_FLOWER_PASSWORD=""
+CELERY_FLOWER_USER=""
+DATABASE_URL='postgresql://<user>:<password>@localhost:5432/<database>'
+DJANGO_ACCOUNT_ALLOW_REGISTRATION=False
+DJANGO_AWS_ACCESS_KEY_ID=""
+DJANGO_AWS_SECRET_ACCESS_KEY=""
+DJANGO_AWS_STORAGE_BUCKET_NAME=""
+GITHUB_ACCESS_TOKEN=""
+GITHUB_BRANCH_FOR_WEBAPP=""
+IPYTHONDIR=""
+REDIS_URL=""
+SINEQUA_CONFIGS_GITHUB_REPO=""
+SINEQUA_CONFIGS_REPO_DEV_BRANCH=""
+SINEQUA_CONFIGS_REPO_MASTER_BRANCH=""
+SINEQUA_CONFIGS_REPO_WEBAPP_PR_BRANCH=""
+SLACK_WEBHOOK_URL=""
+USE_DOCKER=no

.envs/.local/.django

@@ -22,8 +22,14 @@ DJANGO_AWS_ACCESS_KEY_ID=''
 DJANGO_AWS_SECRET_ACCESS_KEY=''
 DJANGO_AWS_STORAGE_BUCKET_NAME=''
 
-# GitHub
+# GitHub (please create a new file called .env and put these in there)
 # ------------------------------------------------------------------------------
-GITHUB_ACCESS_TOKEN=''
-SINEQUA_CONFIGS_GITHUB_REPO=''
-GITHUB_BRANCH_FOR_WEBAPP=''
+GITHUB_ACCESS_TOKEN=
+SINEQUA_CONFIGS_GITHUB_REPO='NASA-IMPACT/sde-backend'
+SINEQUA_CONFIGS_REPO_MASTER_BRANCH='master'
+SINEQUA_CONFIGS_REPO_DEV_BRANCH='dev'
+SINEQUA_CONFIGS_REPO_WEBAPP_PR_BRANCH='dummy_branch'
+
+# Slack Webhook
+# ------------------------------------------------------------------------------
+SLACK_WEBHOOK_URL=''

.github/gh-pages.yml

@@ -0,0 +1,54 @@
+# config details can be found on https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-static-site-generators-with-python
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+      - feature-docs
+      - main
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.8'
+
+      - name: Upgrade pip
+        run: |
+          # install pip=>20.1 to use "pip cache dir"
+          python3 -m pip install --upgrade pip
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements/local.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: python3 -m pip install -r ./requirements/local.txt
+
+      - name: Build Sphinx docs
+        run: sphinx-build -b html ./docs ./docs/_build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/feature-docs' || github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build

.gitignore

@@ -294,3 +294,6 @@ Document_Classifier_inference/model.pt
 
 # Database backup
 backup.json
+
+# Prod backup
+prod_backup-20240423.json

.pre-commit-config.yaml

@@ -40,8 +40,8 @@ repos:
         # ignoring everything for now
         exclude: .
         additional_dependencies: [django-stubs, celery,  django-environ, django-extensions, django-crispy-forms,
-        crispy-bootstrap5, django-allauth, django-celery-beat, django-treebeard, djangorestframework, djangorestframework-datatables,
-        django-debug-toolbar, psycopg2-binary, python-slugify, xmltodict,PyGithub, boto3, scrapy, types-requests]
+        crispy-bootstrap5, django-allauth, django-celery-beat, djangorestframework, djangorestframework-datatables,
+        django-debug-toolbar, psycopg2-binary, python-slugify, xmltodict, PyGithub, boto3, scrapy, types-requests]
 
 
 # sets up .pre-commit-ci.yaml to ensure pre-commit dependencies stay up to date