django-mp-prom 0.0.1__tar.gz

django_mp_prom-0.0.1/MANIFEST.in

@@ -0,0 +1,7 @@
+include README.md
+include LICENSE
+include requirements.txt
+recursive-include prom/locale *
+recursive-include prom/static *
+recursive-include prom/templates *
+prune *.pyc

django_mp_prom-0.0.1/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: django-mp-prom
+Version: 0.0.1
+Summary: Django Prom.ua export
+Home-page: https://github.com/pmaigutyak/mp-prom
+Download-URL: https://github.com/pmaigutyak/mp-prom/archive/0.0.1.tar.gz
+Author: Paul Maigutyak
+Author-email: pmaigutyak@gmail.com
+License: MIT
+Dynamic: author
+Dynamic: author-email
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: license
+Dynamic: summary

django_mp_prom-0.0.1/README.md

@@ -0,0 +1,98 @@
+# MP-prom
+
+Django Prom.ua product export.
+
+### Installation
+
+Install with pip:
+
+```
+pip install django-mp-prom
+```
+
+Add `prom` to `INSTALLED_APPS`.
+
+Set `DOMAIN` in settings. The `host` used for absolute links is `https://<DOMAIN>`.
+
+### Export
+
+Subclass `prom.feed.ExportStrategy`. Implement `get_queryset` and every required product field. Override an optional field when the shop has that information.
+
+```python
+from django.urls import path
+
+from prom.feed import ExportStrategy
+from products.models import Product
+
+
+class ProductExport(ExportStrategy):
+
+    def get_queryset(self):
+        return Product.objects.filter(is_visible=True)
+
+    def get_id(self, product):
+        return product.pk
+
+    def get_name(self, product):
+        return product.name
+
+    def get_description(self, product):
+        return product.description
+
+    def get_price(self, product):
+        return product.price
+
+    def get_currency(self, product):
+        return 'UAH'
+
+    def get_availability(self, product):
+        return '+' if product.is_available else '-'
+
+    def get_code(self, product):
+        return product.code
+
+    def get_images(self, product):
+        if not product.logo:
+            return None
+        return f'{self.host}{product.logo.url}'
+
+
+urlpatterns = [
+    path('prom.xls', ProductExport.as_view(), name='prom'),
+]
+```
+
+Required product fields: `id`, `name`, `description`, `price`, `currency`, `availability`.
+
+`availability` is a Prom value: `+` in stock, `-` out of stock, `@` service, `!` ready to ship, or a number of days.
+
+Optional product fields stay out of the file until overridden: `code`, `name_ua`, `keywords`, `keywords_ua`, `description_ua`, `product_type`, `price_from`, `measure_unit`, `minimum_order`, `wholesale_price`, `minimum_wholesale_order`, `quantity`, `images`, `weight`, `width`, `height`, `length`, `discount`, `discount_date_start`, `discount_date_end`, `label`, `vendor`, `country`, `html_title`, `html_title_ua`, `html_description`, `html_description_ua`, `gifts`, `related`, `gift_ids`, `related_ids`, `group_number`, `group_name`, `catalog_url`, `packaging`, `notes`, `product_url`, `gtin`, `mpn`, `unique_id`, `catalog_id`, `group_id`, `variation_group_id`, `location`.
+
+A list is written as one cell joined with a comma and a space. `get_images` can return a list of URLs. Empty values are written as blank cells.
+
+### Groups
+
+The workbook always has `Export Products Sheet` and `Export Groups Sheet`. Override `get_groups` to add rows. Required group fields are `get_groups_number`, `get_groups_name` and `get_groups_id`.
+
+```python
+def get_groups(self):
+    return Category.objects.all()
+
+def get_groups_number(self, group):
+    return group.pk
+
+def get_groups_name(self, group):
+    return group.name
+
+def get_groups_id(self, group):
+    return group.pk
+```
+
+Optional group fields stay out of the sheet until overridden: `name_ua`, `parent_number`, `parent_id`, `image`, `html_title`, `html_title_ua`, `html_description`, `html_description_ua`, `description_before`, `description_before_ua`, `description_after`, `description_after_ua`.
+
+The file is cached at `tmp/prom.xls` for one hour.
+
+### Requirements
+
+* Django
+* xlwt

django_mp_prom-0.0.1/django_mp_prom.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: django-mp-prom
+Version: 0.0.1
+Summary: Django Prom.ua export
+Home-page: https://github.com/pmaigutyak/mp-prom
+Download-URL: https://github.com/pmaigutyak/mp-prom/archive/0.0.1.tar.gz
+Author: Paul Maigutyak
+Author-email: pmaigutyak@gmail.com
+License: MIT
+Dynamic: author
+Dynamic: author-email
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: license
+Dynamic: summary

django_mp_prom-0.0.1/django_mp_prom.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+MANIFEST.in
+README.md
+setup.py
+django_mp_prom.egg-info/PKG-INFO
+django_mp_prom.egg-info/SOURCES.txt
+django_mp_prom.egg-info/dependency_links.txt
+django_mp_prom.egg-info/top_level.txt
+prom/__init__.py
+prom/apps.py
+prom/feed.py

django_mp_prom-0.0.1/django_mp_prom.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

django_mp_prom-0.0.1/django_mp_prom.egg-info/top_level.txt

@@ -0,0 +1 @@
+prom

django_mp_prom-0.0.1/prom/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class PromConfig(AppConfig):
+
+    name = 'prom'
+    verbose_name = 'Prom'

django_mp_prom-0.0.1/prom/feed.py

@@ -0,0 +1,409 @@
+import time
+from io import BytesIO
+from pathlib import Path
+
+import xlwt
+from django.conf import settings
+from django.http import HttpResponse, HttpResponseNotFound
+from django.views import View
+
+
+FEED_FILE_NAME = 'prom.xls'
+FEED_MAX_AGE = 60 * 60
+PRODUCTS_SHEET = 'Export Products Sheet'
+GROUPS_SHEET = 'Export Groups Sheet'
+
+
+class ExportStrategy(View):
+    """Prom.ua Excel export.
+
+    Subclass this view, implement get_queryset and the required product
+    field methods. Override an optional field when the shop has that
+    information. Override get_groups and the group field methods to fill
+    the groups sheet. The shop domain is read from settings.DOMAIN.
+    """
+
+    file_name = FEED_FILE_NAME
+    max_age = FEED_MAX_AGE
+    content_type = 'application/ms-excel'
+    list_separator = ', '
+    product_fields = (
+        ('code', 'Код_товару'),
+        ('name', 'Назва_позиції'),
+        ('name_ua', 'Назва_позиції_укр'),
+        ('keywords', 'Пошукові_запити'),
+        ('keywords_ua', 'Пошукові_запити_укр'),
+        ('description', 'Опис'),
+        ('description_ua', 'Опис_укр'),
+        ('product_type', 'Тип_товару'),
+        ('price', 'Ціна'),
+        ('price_from', 'Ціна_від'),
+        ('currency', 'Валюта'),
+        ('measure_unit', 'Одиниця_виміру'),
+        ('minimum_order', 'Мінімальний_обсяг_замовлення'),
+        ('wholesale_price', 'Оптова_ціна'),
+        ('minimum_wholesale_order', 'Мінімальне_замовлення_опт'),
+        ('quantity', 'Кількість'),
+        ('images', 'Посилання_зображення'),
+        ('weight', 'Вага,кг'),
+        ('width', 'Ширина,см'),
+        ('height', 'Висота,см'),
+        ('length', 'Довжина,см'),
+        ('availability', 'Наявність'),
+        ('discount', 'Знижка'),
+        ('discount_date_start', 'Термін_дії_знижки_від'),
+        ('discount_date_end', 'Термін_дії_знижки_до'),
+        ('label', 'Ярлик'),
+        ('vendor', 'Виробник'),
+        ('country', 'Країна_виробник'),
+        ('html_title', 'HTML_заголовок'),
+        ('html_title_ua', 'HTML_заголовок_укр'),
+        ('html_description', 'HTML_опис'),
+        ('html_description_ua', 'HTML_опис_укр'),
+        ('gifts', 'Подарунки'),
+        ('related', 'Супутні'),
+        ('gift_ids', 'ID_Подарунків'),
+        ('related_ids', 'ID_Супутніх'),
+        ('group_number', 'Номер_групи'),
+        ('group_name', 'Назва_групи'),
+        ('catalog_url', 'Посилання_підрозділу'),
+        ('packaging', 'Спосіб_пакування'),
+        ('notes', 'Особисті_нотатки'),
+        ('product_url', 'Продукт_на_сайті'),
+        ('gtin', 'Код_маркування_(GTIN)'),
+        ('mpn', 'Номер_пристрою_(MPN)'),
+        ('id', 'Ідентифікатор_товару'),
+        ('unique_id', 'Унікальний_ідентифікатор'),
+        ('catalog_id', 'Ідентифікатор_підрозділу'),
+        ('group_id', 'Ідентифікатор_групи'),
+        ('variation_group_id', 'ID_групи_різновидів'),
+        ('location', 'Де_знаходиться_товар'),
+    )
+    required_product_fields = (
+        'id',
+        'name',
+        'description',
+        'price',
+        'currency',
+        'availability',
+    )
+    group_fields = (
+        ('number', 'Номер_групи'),
+        ('name', 'Назва_групи'),
+        ('name_ua', 'Назва_групи_укр'),
+        ('id', 'Ідентифікатор_групи'),
+        ('parent_number', 'Номер_батьківської_групи'),
+        ('parent_id', 'Ідентифікатор_батьківської_групи'),
+        ('image', 'Посилання_зображення_групи'),
+        ('html_title', 'HTML_заголовок_групи'),
+        ('html_title_ua', 'HTML_заголовок_групи_укр'),
+        ('html_description', 'HTML_опис_групи'),
+        ('html_description_ua', 'HTML_опис_групи_укр'),
+        ('description_before', 'Опис_групи_до_списку_товарних_позицій'),
+        (
+            'description_before_ua',
+            'Опис_групи_до_списку_товарних_позицій_укр',
+        ),
+        ('description_after', 'Опис_групи_після_списку_товарних_позицій'),
+        (
+            'description_after_ua',
+            'Опис_групи_після_списку_товарних_позицій_укр',
+        ),
+    )
+    required_group_fields = ('number', 'name', 'id')
+
+    @property
+    def host(self):
+        return f'https://{settings.DOMAIN}'
+
+    def get_queryset(self):
+        raise NotImplementedError
+
+    def get_groups(self):
+        return ()
+
+    def get_id(self, product):
+        raise NotImplementedError
+
+    def get_name(self, product):
+        raise NotImplementedError
+
+    def get_description(self, product):
+        raise NotImplementedError
+
+    def get_price(self, product):
+        raise NotImplementedError
+
+    def get_currency(self, product):
+        raise NotImplementedError
+
+    def get_availability(self, product):
+        raise NotImplementedError
+
+    def get_code(self, product):
+        return None
+
+    def get_name_ua(self, product):
+        return None
+
+    def get_keywords(self, product):
+        return None
+
+    def get_keywords_ua(self, product):
+        return None
+
+    def get_description_ua(self, product):
+        return None
+
+    def get_product_type(self, product):
+        return None
+
+    def get_price_from(self, product):
+        return None
+
+    def get_measure_unit(self, product):
+        return None
+
+    def get_minimum_order(self, product):
+        return None
+
+    def get_wholesale_price(self, product):
+        return None
+
+    def get_minimum_wholesale_order(self, product):
+        return None
+
+    def get_quantity(self, product):
+        return None
+
+    def get_images(self, product):
+        return None
+
+    def get_weight(self, product):
+        return None
+
+    def get_width(self, product):
+        return None
+
+    def get_height(self, product):
+        return None
+
+    def get_length(self, product):
+        return None
+
+    def get_discount(self, product):
+        return None
+
+    def get_discount_date_start(self, product):
+        return None
+
+    def get_discount_date_end(self, product):
+        return None
+
+    def get_label(self, product):
+        return None
+
+    def get_vendor(self, product):
+        return None
+
+    def get_country(self, product):
+        return None
+
+    def get_html_title(self, product):
+        return None
+
+    def get_html_title_ua(self, product):
+        return None
+
+    def get_html_description(self, product):
+        return None
+
+    def get_html_description_ua(self, product):
+        return None
+
+    def get_gifts(self, product):
+        return None
+
+    def get_related(self, product):
+        return None
+
+    def get_gift_ids(self, product):
+        return None
+
+    def get_related_ids(self, product):
+        return None
+
+    def get_group_number(self, product):
+        return None
+
+    def get_group_name(self, product):
+        return None
+
+    def get_catalog_url(self, product):
+        return None
+
+    def get_packaging(self, product):
+        return None
+
+    def get_notes(self, product):
+        return None
+
+    def get_product_url(self, product):
+        return None
+
+    def get_gtin(self, product):
+        return None
+
+    def get_mpn(self, product):
+        return None
+
+    def get_unique_id(self, product):
+        return None
+
+    def get_catalog_id(self, product):
+        return None
+
+    def get_group_id(self, product):
+        return None
+
+    def get_variation_group_id(self, product):
+        return None
+
+    def get_location(self, product):
+        return None
+
+    def get_groups_number(self, group):
+        raise NotImplementedError
+
+    def get_groups_name(self, group):
+        raise NotImplementedError
+
+    def get_groups_id(self, group):
+        raise NotImplementedError
+
+    def get_groups_name_ua(self, group):
+        return None
+
+    def get_groups_parent_number(self, group):
+        return None
+
+    def get_groups_parent_id(self, group):
+        return None
+
+    def get_groups_image(self, group):
+        return None
+
+    def get_groups_html_title(self, group):
+        return None
+
+    def get_groups_html_title_ua(self, group):
+        return None
+
+    def get_groups_html_description(self, group):
+        return None
+
+    def get_groups_html_description_ua(self, group):
+        return None
+
+    def get_groups_description_before(self, group):
+        return None
+
+    def get_groups_description_before_ua(self, group):
+        return None
+
+    def get_groups_description_after(self, group):
+        return None
+
+    def get_groups_description_after_ua(self, group):
+        return None
+
+    def get_feed_path(self):
+        return Path(settings.BASE_DIR) / 'tmp' / self.file_name
+
+    def get(self, request, *args, **kwargs):
+        path = self.get_feed_path()
+        if self._is_stale(path):
+            self.write_feed(path)
+
+        try:
+            data = path.read_bytes()
+        except OSError:
+            return HttpResponseNotFound()
+
+        response = HttpResponse(data, content_type=self.content_type)
+        response['Content-Disposition'] = (
+            f'attachment; filename="{self.file_name}"'
+        )
+        return response
+
+    def _is_stale(self, path):
+        try:
+            mtime = path.stat().st_mtime
+        except OSError:
+            return True
+        return time.time() - mtime > self.max_age
+
+    def write_feed(self, path):
+        path.parent.mkdir(parents=True, exist_ok=True)
+        path.write_bytes(self.render_feed())
+
+    def render_feed(self):
+        book = xlwt.Workbook(encoding='utf-8')
+        self._write_sheet(
+            book.add_sheet(PRODUCTS_SHEET),
+            self._columns(
+                self.product_fields,
+                self.required_product_fields,
+                'get_',
+            ),
+            self.get_queryset(),
+        )
+        self._write_sheet(
+            book.add_sheet(GROUPS_SHEET),
+            self._columns(
+                self.group_fields,
+                self.required_group_fields,
+                'get_groups_',
+            ),
+            self.get_groups(),
+        )
+        stream = BytesIO()
+        book.save(stream)
+        return stream.getvalue()
+
+    def _columns(self, fields, required, prefix):
+        columns = []
+        for key, header in fields:
+            method = prefix + key
+            if key in required or self._overridden(method):
+                columns.append((method, header))
+        return columns
+
+    def _overridden(self, method):
+        return getattr(type(self), method) is not getattr(
+            ExportStrategy, method
+        )
+
+    def _write_sheet(self, sheet, columns, rows):
+        for index, (_method, header) in enumerate(columns):
+            sheet.write(0, index, header)
+
+        for row_index, item in enumerate(rows, start=1):
+            for index, (method, _header) in enumerate(columns):
+                sheet.write(
+                    row_index,
+                    index,
+                    self._cell(getattr(self, method)(item)),
+                )
+
+    def _cell(self, value):
+        if isinstance(value, (list, tuple)):
+            parts = [
+                str(item)
+                for item in value
+                if item is not None and item != ''
+            ]
+            value = self.list_separator.join(parts)
+        if value is None:
+            return ''
+        return value

django_mp_prom-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

django_mp_prom-0.0.1/setup.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+
+
+version = '0.0.1'
+url = 'https://github.com/pmaigutyak/mp-prom'
+
+
+setup(
+    name='django-mp-prom',
+    version=version,
+    description='Django Prom.ua export',
+    author='Paul Maigutyak',
+    author_email='pmaigutyak@gmail.com',
+    url=url,
+    download_url='{}/archive/{}.tar.gz'.format(url, version),
+    packages=find_packages(),
+    include_package_data=True,
+    license='MIT',
+)