Merge branch 'develop'

Author: kristikotini

.github/workflows/backend-workflow.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - Project/backend/**
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - Project/backend/**
+
+defaults:
+  run:
+    working-directory: main/Project/backend/
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          path: main
+
+        # Install python
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Install dependencies
+        run:
+          pip install -r codebase/requirements.txt
+
+      - name: Run tests
+        run: bash scripts/test.sh

Project/backend/.dockerignore

@@ -0,0 +1,33 @@
+# Ignore files generated by text editors
+*~
+*.swp
+
+# Ignore version control files and directories
+.git
+.gitignore
+svn
+CVS
+
+# Ignore Python bytecode files and cache directories
+*.pyc
+__pycache__
+
+# Ignore local development settings files
+.env
+.local
+.venv
+
+# Ignore Docker build context directories
+.dockerignore
+.docker
+
+# Ignore node_modules directory
+node_modules
+
+# Ignore media/storage files
+/media
+
+#Ignore pytest files
+.pytest_cache
+/.pytest_cache
+.coverage

Project/backend/.env.example

@@ -0,0 +1,19 @@
+# Application configuration variables
+# BACKEND
+APP_NAME=amos-knowledge-graph
+APP_HOST=0.0.0.0
+APP_PORT=8000
+APP_ENV='dev' # Could be dev, production or test
+DEBUG=True
+ALLOWED_HOSTS=*
+CSRF_TRUSTED_ORIGINS='*'
+CORS_ALLOWED_ORIGINS='*'
+
+# Database
+POSTGRES_USER=amos
+POSTGRES_PASSWORD=password
+POSTGRES_DB=amos
+POSTGRES_PORT=5432
+POSTGRES_HOST=amos-db
+
+JANUS_PORT=8182

Project/backend/.gitignore

@@ -0,0 +1,142 @@
+### Python template
+
+.idea/
+.vscode/
+# 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/
+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/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+*.sqlite3
+*.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+.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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

Project/backend/Makefile

@@ -0,0 +1,60 @@
+include .env
+export $(shell sed 's/=.*//' .env)
+
+
+SHELL := /bin/sh
+PROJECTNAME ?= amos-knowledge-graph
+APP_NAME := $(PROJECTNAME)
+BACKEND_APP_NAME := $(APP_NAME)-backend
+DOCKER_COMPOSE != docker compose 1> /dev/null 2> /dev/null && echo docker compose || echo docker-compose
+
+
+define HELP
+
+Manage $(PROJECTNAME). Usage:
+
+make lint           	Run linter
+make format         	Run formatter
+make test           	Run tests
+make migrations         Create migration files e.g: make migrations message="Your migration message here"
+make migrate            Run migrations
+make build-dev      	Build and run dev environment
+make stop-dev       	Stop dev environment
+make all            	Show help
+
+endef
+
+export HELP
+
+help:
+	@echo "$$HELP"
+
+lint:
+	@bash ./scripts/lint.sh
+
+format:
+	@bash ./scripts/format.sh
+
+test:
+	@bash ./scripts/test.sh
+
+migrations:
+	docker exec -it $(BACKEND_APP_NAME) $(SHELL) "-c" \
+	"alembic revision --autogenerate -m '$(msg)'"
+
+migrate:
+	docker exec -it $(BACKEND_APP_NAME) $(SHELL) "-c" \
+	"alembic upgrade head"
+
+
+build-dev:
+	DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 $(DOCKER_COMPOSE) -f docker-compose.yml up --build -d
+
+
+stop-dev:
+	@$(DOCKER_COMPOSE) -f docker-compose.yml down
+
+
+all: help
+
+.PHONY: help lint format test make-migrations migrate build-dev stop-dev all