Metadata-Version: 2.1
Name: garpix-profitbase
Version: 1.9.1
Home-page: https://github.com/garpixcms/garpix_profitbase
Author: Garpix LTD
Author-email: info@garpix.com
License: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Framework :: Django
Classifier: Programming Language :: Python :: 3.8


Garpix ProfitBase
=================

Пакет интеграции с profitbase.ru

Быстрый старт
-------------

Установка:

.. code-block:: bash

   pip install garpix_profitbase

Добавьте ``garpix_profitbase`` в ``INSTALLED_APPS``\ :

.. code-block:: python

   # settings.py

   INSTALLED_APPS = [
       # ...
       'garpix_profitbase',
   ]

Также, добавьте переменные окружения (файл ``.env``\ ) значениями, полученными от profitbase.ru:

.. code-block:: bash

   PROFITBASE_API_KEY=app-?????????
   PROFITBASE_CLIENT_NAME=???????
   PROFITBASE_COMPANY_ID=????
   ENABLE_GARPIX_AUTH=False

Также, в settings.py необходимо добавить миксины:

.. code-block:: bash

   GARPIX_PROFITBASE_CITY_MIXIN = 'garpix_profitbase.models.empty_mixin.EmptyMixin'
   GARPIX_PROFITBASE_HOUSE_MIXIN = 'garpix_page.models.BasePage'
   GARPIX_PROFITBASE_HOUSE_FLOOR_MIXIN = 'garpix_profitbase.models.empty_mixin.EmptyMixin'
   GARPIX_PROFITBASE_HOUSE_SECTION_MIXIN = 'garpix_profitbase.models.empty_mixin.EmptyMixin'
   GARPIX_PROFITBASE_PROJECT_MIXIN = 'garpix_page.models.BasePage'
   GARPIX_PROFITBASE_PROPERTY_MIXIN = 'garpix_page.models.BasePage'
   GARPIX_PROFITBASE_SPECIAL_OFFER_MIXIN = 'garpix_profitbase.models.empty_mixin.EmptyMixin'
   GARPIX_PROFITBASE_LAYOUT_PLAN_MIXIN = 'garpix_profitbase.models.empty_mixin.EmptyMixin'

Нужно обратиться к администраторам profitbase.ru чтоб они добавили ваш ip в белый список.

Использование
-------------

Для получения данных от profitbase.ru используйте следующую manage.py команду:

.. code-block::

   python3 backend/manage.py profitbase_update

Changelog
=========

Смотри `CHANGELOG.md <CHANGELOG.md>`_.

Contributing
============

Смотри `CONTRIBUTING.md <CONTRIBUTING.md>`_.

License
=======

`MIT <LICENSE>`_

----

Developed by Garpix / `https://garpix.com <https://garpix.com>`_
