From 95927483bf9fa0177c8d320b767a93c344ef2af6 Mon Sep 17 00:00:00 2001 From: Mandel Dashboard Date: Sun, 15 Feb 2026 23:27:26 +0100 Subject: [PATCH] initial commit --- .gitignore | 28 ++++ Jenkinsfile | 71 ++++++++ MANIFEST.in | 3 + Makefile | 62 +++++++ README.rst | 85 ++++++++++ mandelnnadia/__init__.py | 0 mandelnnadia/main.py | 9 + mandelnnadia/ocyan.json | 156 ++++++++++++++++++ mandelnnadia/settings/__init__.py | 0 mandelnnadia/settings/base.py | 36 ++++ mandelnnadia/settings/env/__init__.py | 0 mandelnnadia/settings/env/dev.py | 21 +++ mandelnnadia/settings/env/prd.py | 15 ++ mandelnnadia/settings/env/stg.py | 16 ++ mandelnnadia/static/mandelnnadia/css/.gitkeep | 0 .../static/mandelnnadia/img/.gitignore | 0 .../static/mandelnnadia/js/.gitignore | 0 .../templates/mandelnnadia/.gitignore | 0 mandelnnadia/wsgi.py | 1 + pylintrc | 12 ++ pyproject.toml | 30 ++++ setup.py | 43 +++++ uwsgi-dev.ini | 28 ++++ 23 files changed, 616 insertions(+) create mode 100644 .gitignore create mode 100644 Jenkinsfile create mode 100644 MANIFEST.in create mode 100644 Makefile create mode 100644 README.rst create mode 100644 mandelnnadia/__init__.py create mode 100644 mandelnnadia/main.py create mode 100644 mandelnnadia/ocyan.json create mode 100644 mandelnnadia/settings/__init__.py create mode 100644 mandelnnadia/settings/base.py create mode 100644 mandelnnadia/settings/env/__init__.py create mode 100644 mandelnnadia/settings/env/dev.py create mode 100644 mandelnnadia/settings/env/prd.py create mode 100644 mandelnnadia/settings/env/stg.py create mode 100644 mandelnnadia/static/mandelnnadia/css/.gitkeep create mode 100644 mandelnnadia/static/mandelnnadia/img/.gitignore create mode 100644 mandelnnadia/static/mandelnnadia/js/.gitignore create mode 100644 mandelnnadia/templates/mandelnnadia/.gitignore create mode 100644 mandelnnadia/wsgi.py create mode 100644 pylintrc create mode 100644 pyproject.toml create mode 100644 setup.py create mode 100644 uwsgi-dev.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..416ecf8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,28 @@ +.mypy_cache/ +.pytest_cache/ +.vscode/ +__pycache__/ +*.py[ocd] +db.sqlite3 +develop-eggs +bin +parts +sources +.installed.cfg +.mr.developer.cfg +*.egg-info +eggs/ +/static/* +/documents/ +/media +!/media/image_not_found.jpg +dist/ +build/ +lib +pip-selfcheck.json +pyvenv.cfg +.DS_Store +.coverage +coverage.xml +htmlcov/ +venv/ \ No newline at end of file diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000..bc7c4ba --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,71 @@ +#!/usr/bin/env groovy + +pipeline { + agent any + options { disableConcurrentBuilds() } + + stages { + stage('Build') { + steps { + withPythonEnv('System-CPython-3.10') { + pysh "make" + } + } + } + stage('Lint') { + steps { + withPythonEnv('System-CPython-3.10') { + pysh "make lint" + } + } + } + stage('Test') { + steps { + withPythonEnv('System-CPython-3.10') { + pysh "make test" + } + } + post { + always { + junit allowEmptyResults: true, testResults: '**/nosetests.xml' + } + success { + recordCoverage(tools: [[parser: 'COBERTURA', pattern: '**/coverage.xml']]) + } + } + } + } + post { + always { + echo 'This will always run' + } + success { + echo 'This will run only if successful' + withPythonEnv('System-CPython-3.10') { + echo 'This will run only if successful' + pysh "version --plugin=wheel -B${env.BUILD_NUMBER} --skip-build" + sh "which git" + sh "git push --tags" + } + build job: 'deployment-stg-create', + quietPeriod: 20, + wait: false, + parameters: [ + string(name: 'UPSTREAM_BUILD', value: "mandelnnadia"), + ] + } + failure { + emailext subject: "JENKINS-NOTIFICATION: ${currentBuild.currentResult}: Job '${env.JOB_NAME} #${env.BUILD_NUMBER}'", + body: '${SCRIPT, template="groovy-text.template"}', + recipientProviders: [culprits(), brokenBuildSuspects(), brokenTestsSuspects()] + + } + unstable { + echo 'This will run only if the run was marked as unstable' + } + changed { + echo 'This will run only if the state of the Pipeline has changed' + echo 'For example, if the Pipeline was previously failing but is now successful' + } + } +} diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..e1a9bf0 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,3 @@ +graft mandelnnadia +global-exclude *.py[co] +global-exclude __pycache__ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..fa86fa2 --- /dev/null +++ b/Makefile @@ -0,0 +1,62 @@ +.PHONY: fail-if-no-virtualenv all install loaddata test lint black debug undebug + +all: install migrate loaddata collectstatic + +fail-if-no-virtualenv: +ifndef VIRTUAL_ENV # check for a virtualenv in development environment +ifndef PYENVPIPELINE_VIRTUALENV # check for jenkins pipeline virtualenv +$(error this makefile needs a virtualenv) +endif +endif + +ifndef PIP_INDEX_URL +PIP_INDEX_URL=https://pypi.mandelblog.com/mandel/testing/+simple/ +endif + +ifndef EXTRAS +EXTRAS="[test]" +endif + +install: fail-if-no-virtualenv + PIP_INDEX_URL=${PIP_INDEX_URL} pip install --pre --editable .${EXTRAS} --upgrade --upgrade-strategy=eager --use-deprecated=legacy-resolver + +migrate: + manage.py migrate --no-input + +loaddata: + -manage.py loaddemodata + +collectstatic: + manage.py collectstatic --no-input --verbosity=0 + +lint: fail-if-no-virtualenv + cat mandelnnadia/ocyan.json |python3 -m json.tool 1>/dev/null + ruff format --check --exclude "migrations" mandelnnadia + ruff check --select I --exclude "migrations" --output-format concise mandelnnadia + pylint setup.py mandelnnadia/ + +black: + @ruff format --exclude "migrations" mandelnnadia + @ruff check --select I --exclude "migrations" --fix mandelnnadia + +test: fail-if-no-virtualenv + @coverage run --source='mandelnnadia' `which manage.py` test + @coverage report + @coverage xml + @coverage html + +run: fail-if-no-virtualenv lint test migrate collectstatic + manage.py runserver + +debug: fail-if-no-virtualenv + PIP_INDEX_URL=${PIP_INDEX_URL} pip install --pre ocyan.plugin.debug + +undebug: + PIP_INDEX_URL=${PIP_INDEX_URL} pip uninstall -y ocyan.plugin.debug + +live: + @echo "Did you update the version in setup.py? [y/N]" && read ans && [ $$ans = y ] + rm -fr dist + rm -fr build* + version --plugin=wheel --skip-tag + devpi --index=projects/production upload dist/* diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..1e110ad --- /dev/null +++ b/README.rst @@ -0,0 +1,85 @@ +Project mandelnnadia +==================== + +About mandelnnadia +------------------ +Ocyan project: mandelnnadia + +Installation +------------ +Create a virtualenv, you only need to do this once for each project:: + + mkvirtualenv mandelnnadia + +Next build the project, by installing dependencies and creating the database:: + + make + +Running +------- +Activate the virtualenv:: + + workon mandelnnadia + +You can see which virtualenv is activated, because your +terminal will be prefixed with (mandelnnadia). + +Next start the development server:: + + make run + +Testing +------- +Testing is done with the default Django testing capabilities. Check the 'Testing in Django' chapter in Django documentation for details. + +To run the tests, issue the following command:: + + make test + +Linting +------- +Source code is formatted using the `black`[1] formatter in its default settings. Installing format-on-save support for your editor is highly recommended. +`Pylint`[2] is used for source code analysis. +All utilities are installed via the test extra. This extra is installed by default when using the Makefile. + +The following command check style and syntax:: + + make lint + + +1. black: https://pypi.org/project/black/ +2. pylint: https://pypi.org/project/pylint/ + +Edit template translation +------------------------- +The translation in templates + +Activate the virtualenv:: + + workon mandelnnadia + +Create the locale directory in the root of the project:: + + mkdir mandelnnadia/locale + +Go in the project_name directory:: + + cd mandelnnadia/ + +Run this command to create a file with all translatable strings in the project (note: this is only for the dutch translations):: + + manage.py makemessages -l nl + +Go to your text editor and go in this file:: + + mandelnnadia/mandelnnadia/locale/nl/LC_MESSAGES/django.po + +This file will have all of the translations some will be correct and dont need to be chanced + +Edit all the translations u want to change +Delete all of the translation u dont want to chance +save file + +Apply the translations:: + + manage.py compilemessages \ No newline at end of file diff --git a/mandelnnadia/__init__.py b/mandelnnadia/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/mandelnnadia/main.py b/mandelnnadia/main.py new file mode 100644 index 0000000..38db8ff --- /dev/null +++ b/mandelnnadia/main.py @@ -0,0 +1,9 @@ +import os +import sys + + +def main(): + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "mandelnnadia.settings.base") + from django.core.management import execute_from_command_line + + execute_from_command_line(sys.argv) diff --git a/mandelnnadia/ocyan.json b/mandelnnadia/ocyan.json new file mode 100644 index 0000000..3c651ea --- /dev/null +++ b/mandelnnadia/ocyan.json @@ -0,0 +1,156 @@ +{ + "ocyan_plugins": [ + "ocyan.plugin.contact_form", + "ocyan.plugin.cookie_jar", + "ocyan.plugin.demo_data", + "ocyan.plugin.django", + "ocyan.plugin.newsletter", + "ocyan.plugin.google_rich_snippets", + "ocyan.plugin.oscar", + "ocyan.plugin.oscar_basket", + "ocyan.plugin.oscar_catalogue", + "ocyan.plugin.oscar_catalogue_dashboard", + "ocyan.plugin.oscar_checkout", + "ocyan.plugin.oscar_communications", + "ocyan.plugin.oscar_elasticsearch", + "ocyan.plugin.oscar_importexport", + "ocyan.plugin.oscar_order", + "ocyan.plugin.oscar_partner", + "ocyan.plugin.oscar_shipping", + "ocyan.plugin.oscar_sequential_order_numbers", + "ocyan.plugin.payment_dummy", + "ocyan.plugin.roadrunner_bs5", + "ocyan.plugin.roadrunner_productchooser", + "ocyan.plugin.sentry_logging", + "ocyan.plugin.seo", + "oxyan.themes", + "ocyan.plugin.varnish", + "ocyan.plugin.wagtail", + "ocyan.plugin.wagtail_blog", + "ocyan.plugin.wagtail_content_page", + "ocyan.plugin.wagtail_oscar_integration", + "ocyan.plugin.roadrunner_highlight_slider" + ], + "settings": { + "cookie_jar": { + "analytical": true, + "functional": true, + "google_analytics": "", + "google_tag_manager": "", + "marketing": false, + "social": false, + "trusted": "" + }, + "django": { + "description": "", + "domain": "mandelnnadia.nl", + "email_from": "webshop@mandelblog.com", + "email_host": "vps.transip.email", + "email_host_password": "CHANGE_ME", + "email_host_user": "noreply@mandelblog.com", + "email_port": "587", + "email_to": "info@mandelnnadia.nl", + "email_use_tls": true, + "language_code": "nl", + "name": "mandelnnadia", + "username": "administrator" + }, + "ocyan_dummy_payment_plugin": { + "help_text": "Hit pay, to simulate payment." + }, + "oscar": { + "allow_anon_checkout": true, + "cancelled_order_status": "cancelled", + "complete_order_status": "complete", + "dashboard_items_per_page": 21, + "default_currency": "EUR", + "delayed_payment_status": "delayed-payment", + "enable_cost_prices": false, + "enable_long_description": true, + "enable_retail_prices": false, + "enable_reviews": true, + "enable_wishlist": true, + "homepage": true, + "initial_order_status": "new", + "moderate_reviews": true, + "order_pipeline": [], + "paid_order_status": "paid", + "product_image_geometry": "x230", + "refund_order_status": "refund", + "shop_base_url": "shop", + "show_tax_everywhere": true, + "tax_rates": [ + "high" + ], + "use_price_incl_tax": true, + "waiting_for_payment_order_status": "pending-payment" + }, + "oscar_catalogue": { + "minimum_quantity_attribute_code": "min_quantity", + "slug_id_separator": "-" + }, + "oscar_communications": { + "invoice": false, + "send_shipping_email": false, + "tracking_url_template": "" + }, + "oscar_elasticsearch": { + "facet_bucket_size": 10, + "facets": [], + "filter_available": false, + "price_ranges": "25, 100, 500, 1000", + "query_page_size": 100 + }, + "oscar_importexport": { + "category_extra_fields": [], + "category_separator": "|", + "product_extra_fields": [], + "stockrecord_extra_fields": [] + }, + "sentry logging": { + "dsn_secret": "https://ad0c04c38c396a76b983f0f6bb6d470c:c326c5497247ae6d38cfb1d6070c133c@sentry.mandelblog.com/10" + }, + "shipping": { + "enable_charged_shipping": true, + "enable_free_shipping": true, + "enable_weightbased_shipping": true, + "paid_shipping_first": true + }, + "themes": { + "theme": "default", + "theme-switcher": false + }, + "theme": { + "category_navigation_depth": 1, + "danger_color": "", + "header": "header5", + "info_color": "", + "menu_depth": 2, + "name": "template9", + "primary_color": "#da0627", + "secondary_color": "", + "secondary_text_color": "", + "success_color": "", + "warning_color": "", + "dark_color": "#333333" + }, + "wagtail": { + "wagtailuserbar_position": "bottom-right" + }, + "wagtail content page": { + "actionbuttons": false, + "add_to_cart": false, + "heading": true, + "html": false, + "image": true, + "paragraph": true, + "table": true + }, + "wagtail_blog": { + "items_per_page": 10 + }, + "wagtail_oscar": { + "sitemap_include_child_products": false + } + } +} diff --git a/mandelnnadia/settings/__init__.py b/mandelnnadia/settings/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/mandelnnadia/settings/base.py b/mandelnnadia/settings/base.py new file mode 100644 index 0000000..177a300 --- /dev/null +++ b/mandelnnadia/settings/base.py @@ -0,0 +1,36 @@ +""" +Django settings for de tilde project. + +For more information on this file, see +https://docs.djangoproject.com/en/2.0/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/2.0/ref/settings/ +""" + +from pathlib import Path + +from configtype.jsonconfig import setup_search_paths + +_project_app_path = Path(__file__).parent.parent +BASE_PATH = _project_app_path.parent +BASE_DIR = str(BASE_PATH) + +setup_search_paths("/etc/ocyan/", str(_project_app_path)) + +from ocyan.main.settings import * # pylint:disable=W0401,W0614 + +INSTALLED_APPS = ["mandelnnadia"] + INSTALLED_APPS + +STATIC_ROOT = str(BASE_PATH / "static") +MEDIA_ROOT = str(BASE_PATH / "media") +PRIVATE_MEDIA_ROOT = str(BASE_PATH / "private") + +DATABASES = { + "default": { + "ENGINE": "django.db.backends.sqlite3", + "NAME": str(BASE_PATH / "db.sqlite3"), + } +} + +SECRET_KEY = "(c5u^+gb^2(l37+v#6k#q631rxa#4feykwb83zut$r%8+3a6&x" diff --git a/mandelnnadia/settings/env/__init__.py b/mandelnnadia/settings/env/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/mandelnnadia/settings/env/dev.py b/mandelnnadia/settings/env/dev.py new file mode 100644 index 0000000..7f31b27 --- /dev/null +++ b/mandelnnadia/settings/env/dev.py @@ -0,0 +1,21 @@ +from ..base import * # pylint:disable=W0401,W0614 + +try: + from mandelnnadia.json import * # pylint:disable=W0401,W0614,E0611,E0401 +except ModuleNotFoundError: + pass + +DEBUG = False +STATIC_ROOT = "/srv/www/mandelnnadia/static/" +MEDIA_ROOT = "/srv/www/mandelnnadia/media/" +PRIVATE_MEDIA_ROOT = "/srv/www/mandelnnadia/private/" + +ALLOWED_HOSTS = ["*"] + +# Force mail to console +EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend" + +EDEN_URL = ["https://search.mandelblog.com:9200"] +# pylint: disable=E0602 +WAGTAILSEARCH_BACKENDS["default"]["URLS"] = EDEN_URL +OSCAR_ELASTICSEARCH_SERVER_URLS = EDEN_URL diff --git a/mandelnnadia/settings/env/prd.py b/mandelnnadia/settings/env/prd.py new file mode 100644 index 0000000..6d3ce30 --- /dev/null +++ b/mandelnnadia/settings/env/prd.py @@ -0,0 +1,15 @@ +from ..base import * # pylint:disable=W0401,W0614 + +try: + from mandelnnadia.json import * # pylint:disable=W0401,W0614,E0611,E0401 +except ModuleNotFoundError: + pass + +DEBUG = False +STATIC_ROOT = "/srv/www/mandelnnadia/static/" +MEDIA_ROOT = "/srv/www/mandelnnadia/media/" +PRIVATE_MEDIA_ROOT = "/srv/www/mandelnnadia/private/" +ALLOWED_HOSTS.append("mandelnnadia.%s" % salt_target) # pylint: disable=E0602 +# pylint: disable=E0602 +WAGTAILSEARCH_BACKENDS["default"]["URLS"] = ["https://search.mandelblog.com:9200"] +EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend" diff --git a/mandelnnadia/settings/env/stg.py b/mandelnnadia/settings/env/stg.py new file mode 100644 index 0000000..0909cab --- /dev/null +++ b/mandelnnadia/settings/env/stg.py @@ -0,0 +1,16 @@ +from ..base import * # pylint:disable=W0401,W0614 + +try: + from mandelnnadia.json import * # pylint:disable=W0401,W0614,E0611,E0401 +except ModuleNotFoundError: + pass + +DEBUG = False +STATIC_ROOT = "/srv/www/mandelnnadia/static/" +MEDIA_ROOT = "/srv/www/mandelnnadia/media/" +PRIVATE_MEDIA_ROOT = "/srv/www/mandelnnadia/private/" + +ALLOWED_HOSTS = ["*"] + +# Force mail to console +EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend" diff --git a/mandelnnadia/static/mandelnnadia/css/.gitkeep b/mandelnnadia/static/mandelnnadia/css/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/mandelnnadia/static/mandelnnadia/img/.gitignore b/mandelnnadia/static/mandelnnadia/img/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/mandelnnadia/static/mandelnnadia/js/.gitignore b/mandelnnadia/static/mandelnnadia/js/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/mandelnnadia/templates/mandelnnadia/.gitignore b/mandelnnadia/templates/mandelnnadia/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/mandelnnadia/wsgi.py b/mandelnnadia/wsgi.py new file mode 100644 index 0000000..814ed47 --- /dev/null +++ b/mandelnnadia/wsgi.py @@ -0,0 +1 @@ +from ocyan.main.wsgi import application # pylint: disable=W0611 diff --git a/pylintrc b/pylintrc new file mode 100644 index 0000000..aa87e62 --- /dev/null +++ b/pylintrc @@ -0,0 +1,12 @@ +[MASTER] +jobs = 1 +load-plugins = pylint_django,pylint_packageinitcheck +django-settings-module = mandelnnadia.settings.base +score = n +ignore = migrations + +[MESSAGES CONTROL] +disable = R,C,W5103,W0707,E5110 + +[TYPECHECK] +ignored-classes = responses diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..863de0a --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,30 @@ +[tool.black] +target_version = ['py36'] +exclude = ''' +( + migrations/* + | mandelnnadia/main.py +) +''' + +[tool.ruff.lint.isort] +known-first-party = ["mandelnnadia"] +section-order = [ + "future", + "standard-library", + "third-party", + "wagtail", + "oscar", + "oscarapi", + "oscarextra", + "ocyan", + "first-party", + "local-folder" +] + +[tool.ruff.lint.isort.sections] +wagtail = ["wagtail", "wagtail_*"] +oscar = ["oscar"] +oscarapi = ["oscarapi"] +oscarextra = ["oscar_*"] +ocyan = ["ocyan"] diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..5f59667 --- /dev/null +++ b/setup.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- +import json + +from setuptools import find_packages, setup + +install_requires: list = ["ocyan.main"] + +# Add frets dependencies +with open("mandelnnadia/ocyan.json", encoding="utf-8") as fp: + config = json.loads(fp.read()) + install_requires.extend(config["ocyan_plugins"]) + +extras_require: dict = { + "test": [ + "pylint-django", + "ruff", + "vdt.versionplugin.wheel", + "coverage", + "ocyan.plugin.testing", + ], + "prd": ["psycopg2-binary"], +} + +PACKAGE_CLASSIFIERS = [ + "License :: Other/Proprietary License", + "Framework :: Ocyan", +] + +setup( + name="mandel-mandelnnadia", + version="0.1.0", + url="https://git.mandelblog.com/mandel-projects/mandelnnadia", + author="Motolani Olaiya", + author_email="motolaniolaiya@gmail.com", + description="Ocyan project: mandelnnadia", + packages=find_packages(), + include_package_data=True, + python_requires=">=3.10", + install_requires=install_requires, + extras_require=extras_require, + entry_points={"console_scripts": ["manage.py=mandelnnadia.main:main"]}, + classifiers=PACKAGE_CLASSIFIERS, +) diff --git a/uwsgi-dev.ini b/uwsgi-dev.ini new file mode 100644 index 0000000..1939172 --- /dev/null +++ b/uwsgi-dev.ini @@ -0,0 +1,28 @@ +[uwsgi] +master = true +chmod-socket = 660 +workers = 1 +reload-mercy = 30 +vacuum = 1 +auto-procname = true +enable-threads = false +lazy = 0 +no-orphans = true +stats = 127.0.0.1:9191 +thunder-lock = false +enable-threads = true + +# dev settings +python-autoreload = 1 +http = 127.0.0.1:8000 +if-env = VIRTUAL_ENV +virtualenv = %(_) +endif = + +# Django settings +env = DJANGO_SETTINGS_MODULE=mandelnnadia.settings.base +module = mandelnnadia.wsgi:application + +# Spoolers +spooler = spooler +spooler-chdir = %d