Merge pull request #21 from akopdev/support-async

Major upgrade to v2

Author: akopdev

.coveragerc

@@ -0,0 +1,4 @@
+[run]
+omit =
+    tests/*
+    setup.py

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 100
+max-complexity = 10

.github/workflows/main.yml

@@ -0,0 +1,37 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Verify
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Setup environment 
+      run: |
+        make init
+    - name: Install dependencies
+      run: |
+        make install
+    - name: Lint
+      run: |
+        make lint
+    - name: Test
+      run: |
+        make test

.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

Makefile

@@ -0,0 +1,102 @@
+.NOTPARALLEL: ;          # wait for this target to finish
+.EXPORT_ALL_VARIABLES: ; # send all vars to shell
+.PHONY: all 			 			 # All targets are accessible for user
+.DEFAULT: help 			 		 # Running Make will run the help target
+
+PYTHON = @.venv/bin/python -m
+APP = bitrix24
+
+# -------------------------------------------------------------------------------------------------
+# help: @ List available tasks on this project
+# -------------------------------------------------------------------------------------------------
+help:
+	@grep -oE '^#.[a-zA-Z0-9]+:.*?@ .*$$' $(MAKEFILE_LIST) | tr -d '#' |\
+	awk 'BEGIN {FS = ":.*?@ "}; {printf "  make%-10s%s\n", $$1, $$2}'
+	 
+# -------------------------------------------------------------------------------------------------
+#  all: @ Apply all checks at once
+# -------------------------------------------------------------------------------------------------
+all: format lint test
+
+# -------------------------------------------------------------------------------------------------
+# init: @ Setup local environment
+# -------------------------------------------------------------------------------------------------
+init: activate install
+
+# -------------------------------------------------------------------------------------------------
+# update: @ Update package dependencies and install them
+# -------------------------------------------------------------------------------------------------
+update: compile install
+
+# -------------------------------------------------------------------------------------------------
+# Activate virtual environment
+# -------------------------------------------------------------------------------------------------
+activate:
+	@python3 -m venv .venv
+	@. .venv/bin/activate 
+	
+# -------------------------------------------------------------------------------------------------
+# Install packages to current environment
+# -------------------------------------------------------------------------------------------------
+install:
+	$(PYTHON) pip install -e .[dev]
+
+# -------------------------------------------------------------------------------------------------
+# test: @ Run tests using pytest
+# -------------------------------------------------------------------------------------------------
+test:
+	$(PYTHON) pytest tests --cov=.
+
+# -------------------------------------------------------------------------------------------------
+# lint: @ Checks the source code against coding standard rules and safety
+# -------------------------------------------------------------------------------------------------
+lint: lint.setup lint.flake8 lint.safety lint.docs
+
+# -------------------------------------------------------------------------------------------------
+# format: @ Format source code and auto fix minor issues
+# -------------------------------------------------------------------------------------------------
+format:
+	$(PYTHON) black --quiet --line-length=100 $(APP)
+	$(PYTHON) isort $(APP)
+
+# -------------------------------------------------------------------------------------------------
+# setup.py 
+# -------------------------------------------------------------------------------------------------
+lint.setup: 
+	$(PYTHON) setup check -s
+
+# -------------------------------------------------------------------------------------------------
+# flake8 
+# -------------------------------------------------------------------------------------------------
+lint.flake8: 
+	$(PYTHON) flake8 --exclude=.venv,.eggs,*.egg,.git,migrations,__init__.py \
+									 --filename=*.py,*.pyx \
+									 --max-line-length=100 .
+
+# -------------------------------------------------------------------------------------------------
+# safety 
+# -------------------------------------------------------------------------------------------------
+lint.safety: 
+	$(PYTHON) safety check --full-report
+
+# -------------------------------------------------------------------------------------------------
+# pydocstyle
+# -------------------------------------------------------------------------------------------------
+# Ignored error codes:
+#   D100	Missing docstring in public module
+#   D101	Missing docstring in public class
+#   D102	Missing docstring in public method
+#   D103	Missing docstring in public function
+#   D104	Missing docstring in public package
+#   D105	Missing docstring in magic method
+#   D106	Missing docstring in public nested class
+#   D107	Missing docstring in __init__
+lint.docs: 
+	$(PYTHON) pydocstyle --convention=numpy --add-ignore=D100,D101,D102,D103,D104,D105,D106,D107 .
+
+# -------------------------------------------------------------------------------------------------
+# clean: @ Remove artifacts and temp files
+# -------------------------------------------------------------------------------------------------
+clean:
+	@rm -rf .venv/ dist/ build/ *.egg-info/ .pytest_cache/ .coverage coverage.xml
+	@find . | grep -E "\(__pycache__|\.pyc|\.pyo\$\)" | xargs rm -rf

README.md

@@ -4,66 +4,75 @@ Easy way to communicate with bitrix24 portal over REST without OAuth 2.0
 
 ## Description
 
-Bitrix24 REST is a simple API wrapper for working with Bitrix24
-REST API over webhooks.
+Bitrix24 REST is an API wrapper for working with Bitrix24 REST API over webhooks.
+No OAuth 2.0 required. It's easy to use and super lightweight, with minimal dependencies.
 
 ## 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
+- Works with both cloud and on-premises versions of Bitrix24.
+- Super easy to setup. No OAuth 2.0 infrastructure required.
+- Built with data analysis in mind and fully compatible with Jupyter Notebook.
+- Fetch paginated data at once without hassle.
+- Works with large datasets and handles rate limits.
 
 ## Installation
+
 ```
 pip install bitrix24-rest
 ```
 
 ## Quickstart
 
 ```python
-from bitrix24 import *
+from bitrix24 import Bitrix24
 
 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:
+In async mode:
 
 ```python
-bx24.callMethod('crm.deal.list',
-                order={'STAGE_ID': 'ASC'},
-                filter={'>PROBABILITY': 50},
-                select=['ID', 'TITLE', 'STAGE_ID', 'PROBABILITY'])
-```
+import asyncio
+from bitrix24 import bitrix24
 
-Catch the server error with exception:
+async def main():
+    bx24 = Bitrix24('https://example.bitrix24.com/rest/1/33olqeits4avuyqu')
+    result = await bx24.callMethod('crm.product.list')
+    print(result)
 
-```python
-try:
-    bx24.callMethod('tasks.task.add', fields={'TITLE': 'task for test', 'RESPONSIBLE_ID': 1})
-except BitrixError as message:
-    print(message)
+asyncio.run(main())
 ```
 
+## Advanced usage
+
+- [Using filters and additional parameters](docs/using-filters-and-additional-parameters.md)
+- [Working with large datasets](docs/working-with-large-datasets.md)
+- [Disabling certificate verification](docs/disabling-certificate-verification.md)
+
 ## Notes
-List methods return all available items at once. For large collections
-of data use limits.
 
-## Tests
+List methods return all available items at once. For large collections of data use limits.
 
+## Development
+
+New contributers and pull requests are welcome. If you have any questions or suggestions, feel free to open an issue.
+
+Code comes with makefile for easy code base management. You can check `make help` for more details.
+
+```sh
+make init install # to create a local virtual environment and install dependencies
+
+make test # to run tests
+
+make lint # to run linter
 ```
-python -m unittest discover
-```
 
-## Author
+I suggest to use `make all` before committing your changes as it will run all the necessary checks.
+
+## Support this project
 
-Akop Kesheshyan - <akop.kesheshyan@icloud.com>
+You can support this project by starring ⭐, sharing 📤, and contributing. 
 
-New contributers and pull requests are welcome.
+You can also support the author by buying him a coffee ☕. Click sponsor button on the top of the page.

bitrix24/__init__.py

@@ -1,30 +1,10 @@
-# -*- 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.1.1'
-__author__ = 'Akop Kesheshyan <akop.kesheshyan@icloud.com>'
-__license__ = 'MIT'
-__copyright__ = 'Copyright 2019 Akop Kesheshyan'
-
 from .bitrix24 import Bitrix24
-from .exceptions import BitrixError
+from .exceptions import BitrixError
+
+__all__ = ["Bitrix24", "BitrixError"]