Skip to main content
https://github.com/tarantool/tarantool-python/actions/workflows/testing.yml/badge.svg?branch=master https://github.com/tarantool/tarantool-python/actions/workflows/packing.yml/badge.svg?branch=master

This package is a pure-python client library for Tarantool.

Documentation | Downloads | PyPI | GitHub | Issue tracker

Download and install

With dnf

You can install python3-tarantool RPM package if you use Fedora (34, 35, 36).

Add the repository

$ curl -L https://tarantool.io/OtKysgx/release/2/installer.sh | bash

and then install the package

$ dnf install -y python3-tarantool

With apt

You can install python3-tarantool deb package if you use Debian (10, 11) or Ubuntu (20.04, 22.04).

Add the repository

$ curl -L https://tarantool.io/OtKysgx/release/2/installer.sh | bash

and then install the package

$ apt install -y python3-tarantool

ZIP archive

You can also download zip archive, unpack it and run:

$ make install

Development version

You can also install the development version of the package using pip.

$ pip3 install git+https://github.com/tarantool/tarantool-python.git@master

What is Tarantool?

Tarantool is an in-memory computing platform originally designed by VK and released under the terms of BSD license.

Features

  • ANSI SQL, including views, joins, referential and check constraints

  • Lua packages for non-blocking I/O, fibers, and HTTP

  • MessagePack data format and MessagePack-based client-server protocol

  • Two data engines:

    • memtx – in-memory storage engine with optional persistence

    • vinyl – on-disk storage engine to use with larger data sets

  • Secondary key and index iterator support (can be non-unique and composite)

  • Multiple index types: HASH, BITSET, TREE, RTREE

  • Asynchronous master-master replication

  • Authentication and access control

See More

NOTE

This driver is synchronous, so connection mustn’t be shared between threads/processes.

If you’re looking for an asynchronous Python driver based on asyncio, consider using asynctnt . See also the feature comparison table.

Run tests

On Linux:

$ make test

On Windows:

  • Setup a Linux machine with Tarantool and tt installed. This machine will be referred to as remote in this instruction.

  • (On remote) Copy test/suites/lib/tarantool_python_ci.lua to /etc/tarantool/instances.available.

  • (On remote) Run tt start tarantool_python_ci.

  • Set the following environment variables: * REMOTE_TARANTOOL_HOST=..., * REMOTE_TARANTOOL_CONSOLE_PORT=3302.

  • Run make test.

Build docs

To build documentation, first you must install its build requirements:

$ pip3 install -r docs/requirements.txt

Then run

$ make docs

You may host local documentation server with

$ python3 -m http.server --directory build/sphinx/html

Open localhost:8000 in your browser to read the docs.

License

BSD-2-Clause. See the LICENSE file.

Release files for tarantool 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tarantool 1.3.0
File Size Uploaded
tarantool-1.3.0.tar.gz 291.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tarantool 1.3.0
File Interpreter ABI Platform
tarantool-1.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 385.1 kB

Release files / tarantool-1.3.0.tar.gz

Download URL tarantool-1.3.0.tar.gz
Size 291.9 kB
Tags Source
SHA-256 checksum
How to use checksums
4cb989565cea8304f59116c28be5395537897a08fedfd6caa1fbd299b03f04bd
BLAKE2b-256 checksum
How to use checksums
5b628e3b7fad26b6398147f656792a7fd04e2f5259433eef504cec08af77d5a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.15

Release files / tarantool-1.3.0-py3-none-any.whl

Download URL tarantool-1.3.0-py3-none-any.whl
Size 93.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8ec20dfa0176700ece16e8271d56a320e35e16622dec33099565b07092e4d836
BLAKE2b-256 checksum
How to use checksums
e41c83f9f3769d0eae67d02eaf11f8895dfd18e22056868c155a824de5f62a43
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

1.3.0 This release

2 release files

1.2.0

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.12.1

2 release files

0.12.0

2 release files

0.11.0

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.1

2 release files

0.7.0

0.6.6

2 release files

0.6.5

2 release files

0.6.4

2 release files

0.6.3

2 release files

0.6.2

2 release files

0.6.1

1 release file

0.5.5

1 release file

0.5.4

3 release files

0.5.3

0.5.2

3 release files

0.5.1

2 release files

0.5.0

1 release file

0.3.6

2 release files

0.3.5

3 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page