Release v1.0

.github/workflows/documentation.yml

@@ -1,30 +1,27 @@
-name: 'Deploy documentation'
+name: "Deploy documentation"
 on:
   push:
-  pull_request:
+    branches: [main]
 
 jobs:
-  update_documentation:
+  deploy_documentation:
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./documentation
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-
-    - name: Build Slate documentation
-      env:
-        MONGO_CONNECTION_STRING: ${{ secrets.MONGO_CONNECTION_STRING_READ }}
-      run: |
-        (pip install -r ../query_api/requirements.txt && python generate.py)
-        docker run --rm --name slate -v $(pwd)/build:/srv/slate/build -v $(pwd)/source:/srv/slate/source slatedocs/slate build
+      - name: Checkout
+        uses: actions/checkout@v3
 
-    - name: Deploy documentation to Github Pages
-      uses: JamesIves/github-pages-deploy-action@v4
-      if: github.ref == 'refs/heads/main'
-      with:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        BRANCH: gh-pages
-        FOLDER: $(pwd)/../documentation/build
-        CLEAN: true
+      - name: Build Slate documentation
+        run: |
+          docker run --rm \
+          --name slate \
+          -v ${{ github.workspace }}/build:/srv/slate/build \
+          -v ${{ github.workspace }}/documentation:/srv/slate/source \
+          slatedocs/slate build
+
+      - name: Deploy documentation to Github Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: gh-pages
+          folder: build
+          clean: true

.gitignore

@@ -1,9 +1,132 @@
-*.pyc
-*.egg-info
 .DS_Store
+.dockerignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
 .env
-gcp_credentials.json
-google_credentials.json
-backend-sa-key.json
-_NOTES.md
-documentation/build/
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

Dockerfile

@@ -0,0 +1,12 @@
+FROM python:3.10-slim
+
+ENV PYTHONUNBUFFERED True
+
+ENV APP_HOME /app
+WORKDIR $APP_HOME
+
+RUN apt-get update && apt-get install -y build-essential git
+
+COPY . ./
+
+RUN pip install --no-cache-dir -e .