init

Author: Akop Kesheshyan

.gitignore

@@ -0,0 +1,104 @@
+# 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/
+*.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/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Akop Kesheshyan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1,7 @@
+include LICENSE
+include bitrix24
+<<<<<<< HEAD
+include README.rst
+=======
+include README.md
+>>>>>>> a4dbdba3abc7bbb6024b32a1383cf6d7552a94c4

README.md

@@ -0,0 +1,63 @@
+# Bitrix24 REST API for Python
+
+Easy way to communicate with bitrix24 portal over REST without OAuth 2.0
+
+## Description
+
+Bitrix24-python-rest is a simple API wrapper for working with Bitrix24
+REST API over webhooks.
+
+## Features
+
+- Works both with cloud and on-premises versions of bitrix24, much more
+- Super easy for setting up. No OAuth implemetation required
+- Compatible with latests Bitrix24 REST API
+
+## Requirements
+- Python 2.6+ or 3.2+
+- requests
+
+## Installation
+```
+pip install bitrix24-python-rest
+```
+
+## Quickstart
+
+```python
+from bitrix24 import *
+
+bx24 = Bitrix24('https://example.bitrix24.com/rest/1/33olqeits4avuyqu')
+
+print(bx24.callMethod('crm.product.list'))
+```
+
+## Advanced usage
+
+You can define filters and additional parameters in any order:
+
+```python
+bx24.callMethod('crm.deal.list',
+                order={'STAGE_ID': 'ASC'},
+                filter={'>PROBABILITY': 50},
+                select=['ID', 'TITLE', 'STAGE_ID', 'PROBABILITY'])
+```
+
+Catch the server error with exception:
+
+```python
+try:
+    bx24.callMethod('tasks.task.add', fields={'TITLE': 'task for test', 'RESPONSIBLE_ID': 1})
+except BitrixError as message:
+    print(message)
+```
+
+## Notes
+List methods return all available items at once. For large collections
+of data use limits.
+
+## Author
+
+Akop Kesheshyan - <akop.kesheshyan@icloud.com>
+
+New contributers and pull requests are welcome.

bitrix24/__init__.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+
+#   ____  _ _        _      ____  _  _     ____  _____ ____ _____
+#  | __ )(_) |_ _ __(_)_  _|___ \| || |   |  _ \| ____/ ___|_   _|
+#  |  _ \| | __| '__| \ \/ / __) | || |_  | |_) |  _| \___ \ | |
+#  | |_) | | |_| |  | |>  < / __/|__   _| |  _ <| |___ ___) || |
+#  |____/|_|\__|_|  |_/_/\_\_____|  |_|   |_| \_\_____|____/ |_|
+
+
+"""
+Bitrix24 REST library
+~~~~~~~~~~~~~~~~~~~~~
+
+Bitrix24 REST provides easy way to communicate with bitrix24 portal over REST without OAuth 2.0. 
+usage:
+
+   >>> from bitrix24 import Bitrix24
+   >>> bx24 = Bitrix24('https://example.bitrix24.com/rest/1/33olqeits4avuyqu')
+   >>> r = bx24.callMethod('crm.product.list')
+
+Copyright (c) 2019 by Akop Kesheshyan.
+"""
+
+__version__ = '1.0.1'
+__author__ = 'Akop Kesheshyan <akop.kesheshyan@icloud.com>'
+__license__ = 'MIT'
+__copyright__ = 'Copyright 2019 Akop Kesheshyan'
+
+from .bitrix24 import Bitrix24
+from .exceptions import BitrixError

bitrix24/bitrix24.py

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+
+"""
+Bitrix24
+~~~~~~~~~~~~
+
+This module implements the Bitrix24 REST API.
+
+:copyright: (c) 2019 by Akop Kesheshyan.
+
+"""
+import requests
+from time import sleep
+from .exceptions import BitrixError
+
+
+class Bitrix24(object):
+    """A user-created :class:`Bitrix24 <Bitrix24>` object.
+    Used to sent to the server.
+
+    :param domain: REST call domain, including account name, user ID and secret code.
+    :param timeout: (Optional) waiting for a response after a given number of seconds.
+    Usage::
+      >>> from bitrix24 import Bitrix24
+      >>> bx24 = Bitrix24('https://example.bitrix24.com/rest/1/33olqeits4avuyqu')
+      >>> bx24.callMethod('crm.product.list')
+    """
+
+    def __init__(self, domain, timeout=60):
+        self.domain = domain
+        self.timeout = timeout
+
+    def _prepare_params(self, params):
+        """Transforms list of params to a valid bitrix array."""
+
+        new_params = {}
+        for index, value in params.items():
+            if type(value) is dict:
+                for i, v in value.items():
+                    new_params['%s[%s]' % (index, i)] = v
+            else:
+                new_params[index] = value
+        return new_params
+
+    def callMethod(self, method, **params):
+        """Calls a REST method with specified parameters.
+
+       :param url: REST method name.
+       :param \*\*params: Optional arguments which will be converted to a POST request string.
+       :return: Returning the REST method response as an array, an object or a scalar
+       """
+
+        try:
+            url = '{0}/{1}.json'.format(self.domain, method)
+
+            p = self._prepare_params(params)
+
+            if method.rsplit('.', 1)[0] in ['add', 'update', 'delete', 'set']:
+                r = requests.post(url, data=p, timeout=self.timeout).json()
+            else:
+                r = requests.get(url, params=p, timeout=self.timeout).json()
+        except ValueError:
+            if r['error'] not in 'QUERY_LIMIT_EXCEEDED':
+                raise BitrixError(r)
+            # Looks like we need to wait until expires limitation time by Bitrix24 API
+            sleep(2)
+            return self.callMethod(method, **params)
+        
+        if 'error' in r:
+            raise BitrixError(r)
+        if 'page' not in params:
+            params['page'] = 1
+        if 'next' in r and r['total'] > (r['next']*params['page']):
+            params['page'] += 1
+            return r['result'] + self.callMethod(method, **params)
+        return r['result']

bitrix24/exceptions.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+"""
+Bitrix24.exceptions
+~~~~~~~~~~~~~~~~~~~
+
+This module contains the set of Bitrix24 REST exceptions.
+
+:copyright: (c) 2019 by Akop Kesheshyan.
+
+"""
+
+
+class BitrixError(ValueError):
+    def __init__(self, response):
+        super().__init__(response['error_description'])
+        self.code = response['error']

setup.py

@@ -0,0 +1,69 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+#   ____  _ _        _      ____  _  _     ____  _____ ____ _____
+#  | __ )(_) |_ _ __(_)_  _|___ \| || |   |  _ \| ____/ ___|_   _|
+#  |  _ \| | __| '__| \ \/ / __) | || |_  | |_) |  _| \___ \ | |
+#  | |_) | | |_| |  | |>  < / __/|__   _| |  _ <| |___ ___) || |
+#  |____/|_|\__|_|  |_/_/\_\_____|  |_|   |_| \_\_____|____/ |_|
+
+"""
+Setup file for Bitrix24 REST API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Copyright (c) 2019 by Akop Kesheshyan.
+"""
+
+from distutils.core import setup
+from setuptools import find_packages
+
+# read the contents of your README file
+from os import path
+this_directory = path.abspath(path.dirname(__file__))
+with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name='bitrix24-python-rest',
+    version='1.0.0',
+    install_requires=['requests'],
+    packages=find_packages(),
+    url='https://github.com/akopkesheshyan/bitrix24-python-rest',
+    license='MIT',
+    author='Akop Kesheshyan',
+    author_email='akop.kesheshyan@icloud.com',
+    description='Bitrix24 REST API wrapper provides easy way to communicate with bitrix24 portal over REST without OAuth',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    keywords='bitrix24 api rest',
+    classifiers=[
+        # How mature is this project? Common values are
+        #   3 - Alpha
+        #   4 - Beta
+        #   5 - Production/Stable
+        'Development Status :: 5 - Production/Stable',
+
+        # Indicate who your project is intended for
+        'Intended Audience :: Developers',
+        'Natural Language :: Russian',
+        'Natural Language :: English',
+        'Operating System :: OS Independent',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+
+        # Pick your license as you wish (should match "license" above)
+        'License :: OSI Approved :: MIT License',
+
+        # Specify the Python versions you support here. In particular, ensure
+        # that you indicate whether you support Python 2, Python 3 or both.
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.6',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.2',
+        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+    ],
+)