{"id":14988054,"url":"https://github.com/apache/ignite-python-thin-client","last_synced_at":"2025-04-12T14:55:27.509Z","repository":{"id":38373337,"uuid":"314304931","full_name":"apache/ignite-python-thin-client","owner":"apache","description":"Apache Ignite Python Thin Client","archived":false,"fork":false,"pushed_at":"2025-02-08T06:29:14.000Z","size":611,"stargazers_count":28,"open_issues_count":4,"forks_count":19,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-04-03T13:18:58.404Z","etag":null,"topics":["ignite","python"],"latest_commit_sha":null,"homepage":"https://ignite.apache.org/","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-19T16:25:36.000Z","updated_at":"2025-02-26T21:59:02.000Z","dependencies_parsed_at":"2024-06-19T01:30:33.393Z","dependency_job_id":"d8e09725-02d1-4387-9583-3d67a80619a1","html_url":"https://github.com/apache/ignite-python-thin-client","commit_stats":{"total_commits":76,"total_committers":12,"mean_commits":6.333333333333333,"dds":0.5789473684210527,"last_synced_commit":"a870b6cf9d87b11f363295994b2e78b0afb3d0bd"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fignite-python-thin-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fignite-python-thin-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fignite-python-thin-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fignite-python-thin-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/ignite-python-thin-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248521140,"owners_count":21118006,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ignite","python"],"created_at":"2024-09-24T14:16:00.829Z","updated_at":"2025-04-12T14:55:27.486Z","avatar_url":"https://github.com/apache.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ignite-python-client\nApache Ignite thin (binary protocol) client, written in Python 3.\n\n\u003ca href=\"https://ignite.apache.org/\"\u003e\u003cimg src=\"https://github.com/apache/ignite-website/blob/master/assets/images/apache_ignite_logo.svg\" hspace=\"20\"/\u003e\u003c/a\u003e\n\n![Build Status](https://github.com/apache/ignite-python-thin-client/actions/workflows/pr_check.yml/badge.svg)\n[![License](https://img.shields.io/github/license/apache/ignite-python-thin-client?color=blue)](https://www.apache.org/licenses/LICENSE-2.0.html)\n[![Pypi](https://img.shields.io/pypi/v/pyignite)](https://pypi.org/project/pyignite/)\n[![Downloads](https://static.pepy.tech/badge/pyignite/month)](https://pepy.tech/project/pyignite)\n\n\n## Prerequisites\n\n- Python 3.7 or above (3.7, 3.8, 3.9, 3.10 and 3.11 are tested),\n- Access to Apache Ignite node, local or remote. The current thin client\n  version was tested on Apache Ignite 2.14 (binary client protocol 1.7.0).\n\n## Installation\n\n### *for end user*\nIf you only want to use the `pyignite` module in your project, do:\n```bash\n$ pip install pyignite\n```\n\n### *for developer*\nIf you want to run tests, examples or build documentation, clone\nthe whole repository:\n```bash\n$ git clone git@github.com:apache/ignite-python-thin-client.git\n$ pip install -e .\n```\n\nThis will install the repository version of `pyignite` into your environment\nin so-called “develop” or “editable” mode. You may read more about\n[editable installs](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)\nin the `pip` manual.\n\nThen run through the contents of `requirements` folder to install\nthe additional requirements into your working Python environment using\n```bash\n$ pip install -r requirements/\u003cyour task\u003e.txt\n```\n\nYou may also want to consult the `setuptools` manual about using `setup.py`.\n\n### *optional C extension*\nThere is an optional C extension to speedup some computational intensive tasks. If it's compilation fails\n(missing compiler or CPython headers), `pyignite` will be installed without this module.\n\n- On Linux or MacOS X only C compiler is required (`gcc` or `clang`). It compiles during standard setup process.\n- For building universal `wheels` (binary packages) for Linux, just invoke script `./scripts/create_distr.sh`. \n  \n  ***NB!* Docker is required.**\n  \n- On Windows MSVC 14.x required, and it should be in path, also python versions 3.7, 3.8, 3.9, 3.10 and 3.11 both for x86 and\n  x86-64 should be installed. You can disable some of these versions but you'd need to edit script for that.\n- For building `wheels` for Windows, invoke script `.\\scripts\\BuildWheels.ps1` using PowerShell. Just make sure that\n  your execution policy allows execution of scripts in your environment.\n  \n  Ready wheels for `x86` and `x86-64` for different python versions (3.7, 3.8, 3.9, 3.10 and 3.11) will be\n  located in `distr` directory.\n\n### Updating from older version\n\nTo upgrade an existing package, use the following command:\n```bash\npip install --upgrade pyignite\n```\n\nTo install the latest version of a package:\n```bash\npip install pyignite\n```\n\nTo install a specific version:\n```bash\npip install pyignite==0.6.1\n```\n\n## Documentation\n[The package documentation](https://apache-ignite-binary-protocol-client.readthedocs.io)\nis available at *RTD* for your convenience.\n\nIf you want to build the documentation from source, do the developer\ninstallation as described above, then run the following commands from the\nclient's root directory:\n```bash\n$ pip install -r requirements/docs.txt\n$ cd docs\n$ make html\n```\n\nThen open `docs/generated/html/index.html` in your browser.\n\n## Examples\nSome examples of using pyignite are provided in `examples` folder. They are\nextensively commented in the\n“[Examples of usage](https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/examples.html)”\nsection of the documentation.\n\nThis code implies that it is run in the environment with `pyignite` package\ninstalled, and Apache Ignite node is running on localhost:10800.\n\n## Testing\n*NB!* It is recommended installing `pyignite` in development mode.\nRefer to [this section](#for-developer) for instructions.\n\nDo not forget to install test requirements: \n```bash\n$ pip install -r requirements/install.txt -r requirements/tests.txt\n```\n\nAlso, you'll need to have a binary release of Ignite with `log4j2` enabled and to set\n`IGNITE_HOME` environment variable: \n```bash\n$ cd \u003cignite_binary_release\u003e\n$ export IGNITE_HOME=$(pwd)\n$ cp -r $IGNITE_HOME/libs/optional/ignite-log4j2 $IGNITE_HOME/libs/\n```\n### Run basic tests\n```bash\n$ pytest\n```\n### Run with examples\n```bash\n$ pytest --examples \n```\n\nIf you need to change the connection parameters, see the documentation on\n[testing](https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/readme.html#testing).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fignite-python-thin-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fignite-python-thin-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fignite-python-thin-client/lists"}