bayanat v2.0

.env-sample

@@ -43,4 +43,23 @@ SECURITY_TWO_FACTOR_AUTHENTICATOR_VALIDITY=90
 # Can be switched off in dev envs
 SECURE_COOKIES=True
 
-TESSERACT_CMD="/opt/homebrew/bin/tesseract"
+# Logging
+LOG_LEVEL=ERROR
+LOG_DIR=logs
+LOG_FILE=bayanat.log
+LOG_BACKUP_COUNT=10
+
+# Backups
+# Backups of Bayanat's database can be taken on a 
+# specific interval set below. Backups can be stored
+# locally or uploaded to an S3 bucket
+BACKUPS=0
+# set interval of backups every x days
+BACKUP_INTERVAL=1
+# local directory to store backups, default backups/
+BACKUPS_LOCAL_PATH=''
+# S3 settings, if active backups will be uploaded to S3 bucket
+BACKUPS_S3_BUCKET=''
+BACKUPS_AWS_ACCESS_KEY_ID=''
+BACKUPS_AWS_SECRET_ACCESS_KEY=''
+BACKUPS_AWS_REGION=''

.gitignore

@@ -20,3 +20,9 @@ enferno/media/*
 *.xlsx
 .aws
 config.json
+build
+docs/source
+!docs/source/index.rst
+!docs/source/conf.py
+!docs/source/intro.rst
+backups/*

CONTRIBUTING.md

@@ -104,4 +104,17 @@ After creating the test db, you can run the existing tests with
 pytest
 ```
 
-Tests define `pydantic` models to ensure the backend responses and frontend requests conform to expected database schema.
+Tests define `pydantic` models to ensure the backend responses and frontend requests conform to expected database schema.
+
+# Auto-Docs
+
+Bayanat backend code is documented in ReStructured Text format (loosely following Google's guidelines).
+
+To generate automatic documentation in html format, you can follow the following steps:
+
+1. Make sure `sphinx` is installed on your system
+2. Navigate to bayanat directory on terminal
+3. Run `sphinx-apidoc -f -o docs/source enferno && sphinx-apidoc -f -o docs/source tests`
+4. Run `sphinx-build -M html docs/source/ docs/build/`, you will see multiple warning messages on your terminal. Ignore them.
+
+Following these steps, the html files generated will be available under `docs/build/html`

backups/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

dev-requirements.txt

@@ -1,6 +1,5 @@
 -r requirements.txt
 pytest==7.4.4
-pydantic==1.10.13
 flask_pydantic==0.11.0
 SQLAlchemy-Utils==0.41.1
 pre-commit==3.5.0

docker-compose-test.yml

@@ -55,10 +55,12 @@ services:
       - '${PWD}/${ENV_FILE:-.env.test}:/app/.env:ro'
       - 'bayanat_test_media:/app/enferno/media:rw'
       - 'bayanat_test_imports:/app/enferno/imports:rw'
+      - 'bayanat_test_logs:/app/logs:rw'
     command: [ "pytest" ]
 
 volumes:
   redis_test_data:
   postgres_test_data:
   bayanat_test_media:
-  bayanat_test_imports:
+  bayanat_test_imports:
+  bayanat_test_logs:

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)