Feature/odoo sync backend

backend/.dockerignore

@@ -0,0 +1 @@
+.venv

backend/.env.example

@@ -0,0 +1,18 @@
+DATABASE_HOST=
+DATABASE_PORT=
+DATABASE_NAME=
+DATABASE_USER=
+DATABASE_PASSWORD=
+
+ODOO_HOST=
+ODOO_PORT=
+ODOO_DATABASE=
+ODOO_DB_USERNAME=
+ODOO_DB_PASSWORD=
+ODOO_USERNAME=
+ODOO_PASSWORD=
+ODOO_URL=
+
+RUN_MODE=
+SYNC_INTERVAL_SECONDS=
+LOG_LEVEL=

backend/.gitignore

@@ -0,0 +1,3 @@
+.venv/
+.env
+__pychache__/

backend/Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.11-slim
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    gcc libpq-dev curl \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+RUN chmod +x entrypoint.sh
+RUN chmod +x odoouserpermision.sh
+
+CMD ["./entrypoint.sh"]

backend/Makefile

@@ -0,0 +1,58 @@
+.PHONY: help up down build logs restart migrate test shell seed clean
+
+help:
+	@echo "Available commands:"
+	@echo "  make up        - Start all containers"
+	@echo "  make down      - Stop all containers"
+	@echo "  make build     - Build docker images"
+	@echo "  make logs      - Show container logs"
+	@echo "  make restart   - Restart containers"
+	@echo "  make migrate   - Run database migrations"
+	@echo "  make test      - Run tests"
+	@echo "  make shell     - Open backend shell"
+	@echo "  make seed      - Seed Odoo test data"
+	@echo "  make clean     - Remove containers and volumes"
+
+
+up:
+	sudo docker compose up
+
+
+build:
+	sudo docker compose build
+
+
+down:
+	sudo docker compose down
+
+
+restart:
+	sudo docker compose restart
+
+
+logs:
+	sudo docker compose logs -f
+
+
+migrate:
+	sudo docker compose exec backend alembic upgrade head
+
+
+build test:
+	sudo docker compose --profile test build tests
+
+test:
+	sudo docker compose --profile test run --rm tests
+
+
+
+shell:
+	sudo docker compose exec backend bash
+
+
+seed:
+	sudo docker compose exec backend python -m scripts.seed_odoo.main
+
+
+clean:
+	sudo docker compose down -v

backend/README.md

@@ -0,0 +1,73 @@
+
+# Integrate with Odoo
+
+This project implements a backend synchronization service between Odoo ERP and PostgreSQL.
+
+The solution runs Odoo and it's PostgreSQL database using Docker, then connects to Odoo through it's XML-RPC API. During synchronization, the backend retrieves Contacts, Products, Sale Orders, and Sale Order Lines, maps the external Odoo data into internal models, and persists them in a separate PostgreSQL database.
+
+## How to run the project
+
+clone the project
+
+```bash
+    git clone https://github.com/javadnr/education.git
+```
+
+build the docker images
+
+```bash
+    make build
+```
+
+run the container
+
+```bash
+    make up
+```
+
+connect to backend service to create alembic changes
+
+
+```bash
+    make shell
+    alembic revision --autogenerate -m "init"
+```
+
+make migration to database
+
+```bash
+    make migrate
+```
+
+
+## how it works
+
+After we ran the docker container the backend starts to get the data from api and sync to it's database I added 2 functions in the project to run the backend in loop or run it just 1 time.
+
+you can specify the run type in .env file and I putted a .env.example file to see the vars you can set.
+
+## tests
+To run tests 
+
+```bash
+    make build test
+```
+
+## Architecture decisions
+
+The application is designed using a layered architecture with clear separation of concerns. Odoo communication is isolated in an adapter layer, business logic is implemented in services, database access is encapsulated by repositories, and mapping logic is handled by dedicated mappers. This design keeps the system modular, testable, and easy to extend.
+
+
+## Known Limitations
+
+The current implementation satisfies the requirements of the technical assignment; however, several areas can be improved for a production-scale environment:
+
+Synchronization is manually triggered and does not include a scheduling mechanism. In a production environment, it could be executed periodically using a scheduler such as Celery Beat or Cron.
+
+The project currently performs synchronization in a single process. Queue-based processing (e.g., RabbitMQ with background workers) would improve scalability for high-volume workloads.
+
+Conflict detection is limited to the Odoo ID. More advanced synchronization strategies, such as version comparison or timestamp-based conflict resolution, can be added if required.
+
+Monitoring and metrics collection (e.g., Prometheus and Grafana) are outside the scope of this assignment.
+
+Authentication, authorization, and API endpoints are not implemented because the assignment focuses on synchronization between Odoo and PostgreSQL rather than exposing a public backend API.

backend/alembic.ini

@@ -0,0 +1,149 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts.
+# this is typically a path given in POSIX (e.g. forward slashes)
+# format, relative to the token %(here)s which refers to the location of this
+# ini file
+script_location = %(here)s/alembic
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+# Or organize into date-based subdirectories (requires recursive_version_locations = true)
+# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).2d_%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.  for multiple paths, the path separator
+# is defined by "path_separator" below.
+prepend_sys_path = .
+
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the tzdata library which can be installed by adding
+# `alembic[tz]` to the pip requirements.
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to <script_location>/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "path_separator"
+# below.
+# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions
+
+# path_separator; This indicates what character is used to split lists of file
+# paths, including version_locations and prepend_sys_path within configparser
+# files such as alembic.ini.
+# The default rendered in new alembic.ini files is "os", which uses os.pathsep
+# to provide os-dependent path splitting.
+#
+# Note that in order to support legacy alembic.ini files, this default does NOT
+# take place if path_separator is not present in alembic.ini.  If this
+# option is omitted entirely, fallback logic is as follows:
+#
+# 1. Parsing of the version_locations option falls back to using the legacy
+#    "version_path_separator" key, which if absent then falls back to the legacy
+#    behavior of splitting on spaces and/or commas.
+# 2. Parsing of the prepend_sys_path option falls back to the legacy
+#    behavior of splitting on spaces, commas, or colons.
+#
+# Valid values for path_separator are:
+#
+# path_separator = :
+# path_separator = ;
+# path_separator = space
+# path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+path_separator = os
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+# database URL.  This is consumed by the user-maintained env.py script only.
+# other means of configuring database URLs may be customized within the env.py
+# file.
+sqlalchemy.url = 
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
+# hooks = ruff
+# ruff.type = module
+# ruff.module = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Alternatively, use the exec runner to execute a binary found on your PATH
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration.  This is also consumed by the user-maintained
+# env.py script only.
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

backend/alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.