django-mp-avtopro 0.0.1__tar.gz

django_mp_avtopro-0.0.1/MANIFEST.in

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

django_mp_avtopro-0.0.1/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: django-mp-avtopro
+Version: 0.0.1
+Summary: Django AvtoPro export
+Home-page: https://github.com/pmaigutyak/mp-avtopto
+Download-URL: https://github.com/pmaigutyak/mp-avtopto/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_avtopro-0.0.1/README.md

@@ -0,0 +1,76 @@
+# MP-avtopro
+
+Django AvtoPro price-list export.
+
+### Installation
+
+Install with pip:
+
+```
+pip install django-mp-avtopro
+```
+
+Add `avtopro` to `INSTALLED_APPS`.
+
+Set `DOMAIN` in settings. The `host` used for absolute links is `https://<DOMAIN>`.
+
+### Export
+
+Subclass `avtopro.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 avtopro.feed import ExportStrategy
+from products.models import Product
+
+
+class ProductExport(ExportStrategy):
+
+    def get_queryset(self):
+        return Product.objects.filter(is_visible=True)
+
+    def get_vendor(self, product):
+        return product.manufacturer.name
+
+    def get_price(self, product):
+        return product.price
+
+    def get_quantity(self, product):
+        return 1
+
+    def get_code(self, product):
+        return product.code
+
+    def get_description(self, product):
+        return product.description
+
+    def get_used(self, product):
+        if product.is_new:
+            return None
+        return '1'
+
+    def get_images(self, product):
+        if not product.logo:
+            return None
+        return f'{self.host}{product.logo.url}'
+
+
+urlpatterns = [
+    path('avtopro.csv', ProductExport.as_view(), name='avtopro'),
+]
+```
+
+Required fields: `vendor`, `price`, `quantity`, `code`.
+
+Optional fields stay out of the file until overridden: `description`, `used`, `images`, `restored`.
+
+`used` is the `Б/У` column. Any non-empty value marks the part as used. Leave it empty for a new part. `restored` is the `Реставрація` column and works the same way.
+
+A list is written as one cell joined with `;`. `get_images` can return a list of URLs. Empty values are written as blank cells.
+
+The file is cached at `tmp/avtopro.csv` for one hour.
+
+### Requirements
+
+* Django

django_mp_avtopro-0.0.1/avtopro/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class AvtoproConfig(AppConfig):
+
+    name = 'avtopro'
+    verbose_name = 'Avtopro'

django_mp_avtopro-0.0.1/avtopro/feed.py

@@ -0,0 +1,140 @@
+import csv
+import time
+from io import StringIO
+from pathlib import Path
+
+from django.conf import settings
+from django.http import HttpResponse, HttpResponseNotFound
+from django.views import View
+
+
+FEED_FILE_NAME = 'avtopro.csv'
+FEED_MAX_AGE = 60 * 60
+
+
+class ExportStrategy(View):
+    """AvtoPro price-list export.
+
+    Subclass this view, implement get_queryset and the required product
+    field methods. Override an optional field when the shop has that
+    information. The shop domain is read from settings.DOMAIN.
+    """
+
+    file_name = FEED_FILE_NAME
+    max_age = FEED_MAX_AGE
+    content_type = 'text/csv'
+    list_separator = ';'
+    product_fields = (
+        ('vendor', 'Виробник'),
+        ('price', 'Ціна'),
+        ('quantity', 'Кількість'),
+        ('code', 'Код'),
+        ('description', 'Опис'),
+        ('used', 'Б/У'),
+        ('images', 'Фото'),
+        ('restored', 'Реставрація'),
+    )
+    required_product_fields = ('vendor', 'price', 'quantity', 'code')
+
+    @property
+    def host(self):
+        return f'https://{settings.DOMAIN}'
+
+    def get_queryset(self):
+        raise NotImplementedError
+
+    def get_vendor(self, product):
+        raise NotImplementedError
+
+    def get_price(self, product):
+        raise NotImplementedError
+
+    def get_quantity(self, product):
+        raise NotImplementedError
+
+    def get_code(self, product):
+        raise NotImplementedError
+
+    def get_description(self, product):
+        return None
+
+    def get_used(self, product):
+        return None
+
+    def get_images(self, product):
+        return None
+
+    def get_restored(self, product):
+        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):
+        stream = StringIO()
+        writer = csv.writer(stream)
+        columns = self._columns()
+        writer.writerow([header for _method, header in columns])
+
+        for product in self.get_queryset():
+            writer.writerow([
+                self._cell(getattr(self, method)(product))
+                for method, _header in columns
+            ])
+
+        return stream.getvalue().encode('utf-8')
+
+    def _columns(self):
+        columns = []
+        for key, header in self.product_fields:
+            method = f'get_{key}'
+            if (
+                key in self.required_product_fields
+                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 _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_avtopro-0.0.1/django_mp_avtopro.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: django-mp-avtopro
+Version: 0.0.1
+Summary: Django AvtoPro export
+Home-page: https://github.com/pmaigutyak/mp-avtopto
+Download-URL: https://github.com/pmaigutyak/mp-avtopto/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_avtopro-0.0.1/django_mp_avtopro.egg-info/SOURCES.txt

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

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1 @@
+avtopro

django_mp_avtopro-0.0.1/setup.cfg

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

django_mp_avtopro-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-avtopto'
+
+
+setup(
+    name='django-mp-avtopro',
+    version=version,
+    description='Django AvtoPro 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',
+)