Certificate of Higher Education Project

.gitignore

@@ -0,0 +1,265 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,flask
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,flask
+
+### Users images ###
+notlar/static/img/users/
+
+### Flask ###
+instance/*
+!instance/.gitignore
+.webassets-cache
+.env
+
+### Flask.Python Stack ###
+# 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
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+
+# 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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+
+# C extensions
+
+# Distribution / packaging
+
+# 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.
+
+# Installer logs
+
+# Unit test / coverage reports
+
+# Translations
+
+# Django stuff:
+
+# Flask stuff:
+
+# Scrapy stuff:
+
+# Sphinx documentation
+
+# PyBuilder
+
+# Jupyter Notebook
+
+# IPython
+
+# 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.
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+
+# Celery stuff
+
+# SageMath parsed files
+
+# Environments
+
+# Spyder project settings
+
+# Rope project settings
+
+# mkdocs documentation
+
+# mypy
+
+# Pyre type checker
+
+# pytype static type analyzer
+
+# Cython debug symbols
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python,flask

.gitlab-ci.yml

@@ -0,0 +1,56 @@
+---
+stages:
+  - test
+  - build
+  - deploy
+
+variables:
+  DOCKER_IMAGE_TAG: latest
+  DOCKER_IMAGE_NAME: notlar
+
+.ci_master_mr_rule: &ci_master_mr_rule
+  rules:
+    - if: '$CI_COMMIT_BRANCH == "master"'
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+
+.before_script_ssh_configuration:
+  before_script:
+    # https://docs.gitlab.com/ee/ci/ssh_keys/#ssh-keys-when-using-the-docker-executor
+    - which ssh-agent || ( apk add --update openssh )
+    - eval $(ssh-agent -s)
+    - echo "$SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add -
+    - mkdir -p ~/.ssh
+    - chmod 700 ~/.ssh
+
+
+tox_job:
+  stage: test
+  image: python:3.8
+  script:
+    - pip install tox
+    - tox -v
+  <<: *ci_master_mr_rule
+
+build_image:
+  stage: build
+  image:
+    name: gcr.io/kaniko-project/executor:v1.7.0-debug
+    entrypoint: [""]
+  script:
+    - mkdir -p /kaniko/.docker
+    - echo "{\"auths\":{\"$REGISTRY_HOST\":{\"username\":\"$REGISTRY_USERNAME\",\"password\":\"$REGISTRY_PASSWORD\"}}}" > /kaniko/.docker/config.json
+    - /kaniko/executor --context "${CI_PROJECT_DIR}" --dockerfile "${CI_PROJECT_DIR}/Dockerfile" --destination "${REGISTRY_HOST}/${REGISTRY_USERNAME}/${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG}"
+  rules:
+    - changes:
+        - "notlar/**/*"
+
+deploy-notlar:
+  extends: .before_script_ssh_configuration
+  stage: deploy
+  image: alpine:latest
+  script:
+    - ssh -o StrictHostKeyChecking=no $REMOTE_USER@$REMOTE_SERVER 'sudo -u notlar bash -ic "source /home/notlar/venv/bin/activate && pip3 install --upgrade notlar"'
+    - ssh -o StrictHostKeyChecking=no $REMOTE_USER@$REMOTE_SERVER 'sudo supervisorctl reload'
+  rules:
+    - changes:
+        - "notlar/**/*"

.yamllint

@@ -0,0 +1,9 @@
+---
+extends: default
+
+rules:
+  line-length: disable
+  trailing-spaces: enable
+  indentation:
+    spaces: 2
+    indent-sequences: true

Dockerfile

@@ -0,0 +1,14 @@
+FROM python:3.8-slim
+
+WORKDIR /app
+
+COPY requirements.txt /app/
+
+
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Copy the rest of the application code into the container at /app
+COPY . /app/
+
+# Expose port 5000 for the Flask app
+EXPOSE 5000

MANIFEST.in

@@ -0,0 +1,4 @@
+include requirements.txt
+recursive-include notlar/static *
+recursive-include notlar/templates *
+recursive-include notlar/translations *

Makefile

@@ -0,0 +1,40 @@
+# Makefile for Flask Translation Management
+
+# Define available languages
+AVAILABLE_LANGUAGES := es gl
+
+# Define targets
+.PHONY: init_translation_template init_lang_translation_files update_translations execute_translate
+
+# Check if pybabel is installed
+PYBABEL := $(shell command -v pybabel 2> /dev/null)
+
+ifeq ($(PYBABEL),)
+$(error 'pybabel' is not installed. Please install it using 'pip install flask_babel')
+endif
+
+
+# Target: init_translation_template. It will scan all the files added in babel.cfg and create a template
+init_translation_template:
+	$(PYBABEL) extract -F babel.cfg -o notlar/translations/messages.pot .; \
+
+
+# Target: init_lang_translation_files. It will create a folder for each language defined in the AVAILABLE_LANGUAGES variable.
+init_lang_translation_files:
+	@for lang in $(AVAILABLE_LANGUAGES); do \
+		if [ ! -d "notlar/translations/$$lang" ]; then \
+			$(PYBABEL) init -i notlar/translations/messages.pot -d notlar/translations -l $$lang; \
+		fi \
+	done
+
+# Target: update_translations
+update_translations:
+	$(PYBABEL) update -i notlar/translations/messages.pot -d notlar/translations
+
+
+# Target: compile_translations. Once we finish the manual translate we should compile and generate the .po files that will be used for Flask-Babel
+compile_translations:
+	$(PYBABEL) compile -d notlar/translations
+
+# Target: execute_translate. It will execute all the targets in order.
+execute_translate: init_translation_template init_lang_translation_files update_translations compile_translations