Ignite 18006

.asf.yaml

@@ -0,0 +1,34 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+github:
+  description: "Apache Ignite Python Thin Client"
+  homepage: https://ignite.apache.org/
+  labels:
+    - ignite
+    - python
+  features:
+    wiki: false
+    issues: false
+    projects: false
+  enabled_merge_buttons:
+    squash:  true
+    merge:   false
+    rebase:  false
+notifications:
+  commits:      [email protected]
+  issues:       [email protected]
+  pullrequests: [email protected]
+  jira_options: link label worklog

.github/workflows/pr_check.yml

@@ -0,0 +1,58 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Check code style and run tests
+on: [ push, pull_request ]
+
+env:
+  IGNITE_VERSION: 2.14.0
+  IGNITE_HOME: /opt/ignite
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    strategy:
+      fail-fast: false
+      matrix:
+        cfg:
+          - { python: "3.7", toxenv: "py37" }
+          - { python: "3.8", toxenv: "py38" }
+          - { python: "3.9", toxenv: "py39" }
+          - { python: "3.10", toxenv: "py310" }
+          - { python: "3.11", toxenv: "py311" }
+          - { python: "3.11", toxenv: "codestyle" }
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.cfg.python}}
+      - name: Install Apache Ignite
+        run: |
+          curl -L https://apache-mirror.rbc.ru/pub/apache/ignite/${IGNITE_VERSION}/apache-ignite-slim-${IGNITE_VERSION}-bin.zip > ignite.zip
+          unzip ignite.zip -d /opt
+          mv /opt/apache-ignite-slim-${IGNITE_VERSION}-bin /opt/ignite
+          mv /opt/ignite/libs/optional/ignite-log4j2 /opt/ignite/libs/
+
+      - name: Install tox
+        run: |
+          pip install tox
+
+      - name: Run tests
+        run: |
+          pip install tox
+          tox -e ${{ matrix.cfg.toxenv }}

.gitignore

@@ -0,0 +1,16 @@
+.idea
+.benchmarks
+.vscode
+.eggs
+.pytest_cache
+.tox
+*.so
+build
+distr
+docs/generated
+tests/config/*.xml
+junit*.xml
+pyignite.egg-info
+ignite-log-*
+__pycache__
+venv

MANIFEST.in

@@ -0,0 +1,13 @@
+graft requirements
+graft examples
+graft docs
+recursive-exclude docs/generated *
+graft tests
+recursive-exclude tests/config *.xml
+recursive-exclude tests/logs *
+global-exclude *.py[cod]
+global-exclude *__pycache__*
+include tox.ini
+include README.md
+include LICENSE
+include NOTICE

NOTICE

@@ -0,0 +1,5 @@
+Apache Ignite binary client Python API
+Copyright 2021 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).

README.md

@@ -3,24 +3,23 @@ Apache Ignite thin (binary protocol) client, written in Python 3.
 
 ## Prerequisites
 
-- Python 3.4 or above (3.6 is tested),
+- Python 3.7 or above (3.7, 3.8, 3.9 and 3.10 are tested),
 - Access to Apache Ignite node, local or remote. The current thin client
-  version was tested on Apache Ignite 2.7.0 (binary client protocol 1.2.0).
+  version was tested on Apache Ignite 2.10 (binary client protocol 1.7.0).
 
 ## Installation
 
-#### *for end user*
+### *for end user*
 If you only want to use the `pyignite` module in your project, do:
-```
+```bash
 $ pip install pyignite
 ```
 
-#### *for developer*
+### *for developer*
 If you want to run tests, examples or build documentation, clone
 the whole repository:
-```
-$ git clone [email protected]:apache/ignite.git
-$ cd ignite/modules/platforms/python
+```bash
+$ git clone [email protected]:apache/ignite-python-thin-client.git
 $ pip install -e .
 ```
 
@@ -31,45 +30,94 @@ in the `pip` manual.
 
 Then run through the contents of `requirements` folder to install
 the additional requirements into your working Python environment using
-```
+```bash
 $ pip install -r requirements/<your task>.txt
 ```
 
 You may also want to consult the `setuptools` manual about using `setup.py`.
 
+### *optional C extension*
+There is an optional C extension to speedup some computational intensive tasks. If it's compilation fails
+(missing compiler or CPython headers), `pyignite` will be installed without this module.
+
+- On Linux or MacOS X only C compiler is required (`gcc` or `clang`). It compiles during standard setup process.
+- For building universal `wheels` (binary packages) for Linux, just invoke script `./scripts/create_distr.sh`. 
+
+  ***NB!* Docker is required.**
+
+- On Windows MSVC 14.x required, and it should be in path, also python versions 3.7, 3.8, 3.9 and 3.10 both for x86 and
+  x86-64 should be installed. You can disable some of these versions but you'd need to edit script for that.
+- For building `wheels` for Windows, invoke script `.\scripts\BuildWheels.ps1` using PowerShell. Just make sure that
+  your execution policy allows execution of scripts in your environment.
+
+  Ready wheels for `x86` and `x86-64` for different python versions (3.7, 3.8, 3.9 and 3.10) will be
+  located in `distr` directory.
+
+### Updating from older version
+
+To upgrade an existing package, use the following command:
+```bash
+pip install --upgrade pyignite
+```
+
+To install the latest version of a package:
+```bash
+pip install pyignite
+```
+
+To install a specific version:
+```bash
+pip install pyignite==0.5.1
+```
+
 ## Documentation
 [The package documentation](https://apache-ignite-binary-protocol-client.readthedocs.io)
 is available at *RTD* for your convenience.
 
 If you want to build the documentation from source, do the developer
-installation as described above, then run the following commands:
-```
-$ cd ignite/modules/platforms/python
+installation as described above, then run the following commands from the
+client's root directory:
+```bash
 $ pip install -r requirements/docs.txt
 $ cd docs
 $ make html
 ```
 
-Then open `ignite/modules/platforms/python/docs/generated/html/index.html`
-in your browser.
+Then open `docs/generated/html/index.html` in your browser.
 
 ## Examples
-Some examples of using pyignite are provided in
-`ignite/modules/platforms/python/examples` folder. They are extensively
-commented in the
+Some examples of using pyignite are provided in `examples` folder. They are
+extensively commented in the
 “[Examples of usage](https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/examples.html)”
 section of the documentation.
 
 This code implies that it is run in the environment with `pyignite` package
 installed, and Apache Ignite node is running on localhost:10800.
 
 ## Testing
-Run
+*NB!* It is recommended installing `pyignite` in development mode.
+Refer to [this section](#for-developer) for instructions.
+
+Do not forget to install test requirements: 
+```bash
+$ pip install -r requirements/install.txt -r requirements/tests.txt
+```
+
+Also, you'll need to have a binary release of Ignite with `log4j2` enabled and to set
+`IGNITE_HOME` environment variable: 
+```bash
+$ cd <ignite_binary_release>
+$ export IGNITE_HOME=$(pwd)
+$ cp -r $IGNITE_HOME/libs/optional/ignite-log4j2 $IGNITE_HOME/libs/
+```
+### Run basic tests
+```bash
+$ pytest
 ```
-$ cd ignite/modules/platforms/python
-$ python setup.py pytest
+### Run with examples
+```bash
+$ pytest --examples 
 ```
 
-*NB!* All tests require Apache Ignite node running on localhost:10800.
 If you need to change the connection parameters, see the documentation on
 [testing](https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/readme.html#testing).

RELEASE_NOTES.txt

@@ -0,0 +1,48 @@
+Apache Ignite python thin client
+================================
+
+0.5.2
+--------------------------------
+* Fixed incorrect partial read from socket in sync client
+* Fixed nested object arrays deserialization
+
+0.5.1
+--------------------------------
+* Added logging of connection and queries events
+* Added event listeners to connection events and query events
+* Added client's side handshake timeout
+* Fixed excessive deprecation warnings on python 3.7
+* Fixed request to failed node when querying replicated cache
+* Fixed excessive partition mapping requests
+
+0.5.0
+--------------------------------
+* Added transaction API support (sync and async versions, async version supports only python 3.7+)
+* Added ExpiryPolicy (TTL) support
+* Improved performance of asyncio version by reimplementing network code using asyncio transports and protocols
+* Enabled partition awareness by default
+* Fixed handling collections of binary objects
+
+0.4.0
+--------------------------------
+* Added partition awareness support
+* Added asyncio support
+* Added C module to speedup hashcode calculation
+* Implement context management for connection method
+* Implement cursors and context management for ScanQuery, SqlQuery and SqlFieldsQuery
+* Add the ability to activate/deactivate the cluster
+* Implement support for big-endianness
+* Implement support of password for certificates
+* Fix performance issues while working with big bytearrays and binary objects
+* Fix serialization/deserialization of cache configuration
+* Fix handling of null fields
+* Fix SQL API
+* Fix UUID serialization/deserialization
+* Fix nested complex objects
+* Fix incorrect hash code calculation for classes as composite keys
+* Fix hashing of complex object
+* Fix insert and select VARBINARY data type through SQL
+* Fix wrong order of the SQL query result
+* Fix handling of bytes and bytearrays
+* Fix bool arrays handling
+* Fix cache.get_size with non-default PeekModes