Skip to content

Commit a64147b

Browse files
patiencedauroleg-jukovec
authored andcommitted
doc: proofread
* Proofread the English and Russian language * Provide a more human space name * Provide the correct translation of the term "space"
1 parent 60a2f38 commit a64147b

17 files changed

+431
-420
lines changed

CHANGELOG.md

+31-30
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3737
ConnectionPool updates information about each server state (RO/RW)
3838
on initial connect and then asynchronously in separate threads.
3939
Application retries must be written considering the asynchronous nature
40-
of cluster state refresh. User does not need to use any synchronization
40+
of cluster state refresh. The user does not need to use any synchronization
4141
mechanisms in requests, it's all handled with ConnectionPool methods.
4242

43-
ConnectionPool API is the same as a plain Connection API.
44-
On each request, a connection is chosen to execute this request.
45-
A connection is chosen based on a request mode:
46-
* Mode.ANY chooses any instance.
47-
* Mode.RW chooses an RW instance.
48-
* Mode.RO chooses an RO instance.
49-
* Mode.PREFER_RW chooses an RW instance, if possible, RO instance
43+
ConnectionPool API is the same as the plain Connection API.
44+
On each request, a connection is chosen to execute the request.
45+
A connection is chosen based on the request mode:
46+
* `Mode.ANY` chooses any instance.
47+
* `Mode.RW` chooses an RW instance.
48+
* `Mode.RO` chooses an RO instance.
49+
* `Mode.PREFER_RW` chooses an RW instance, if possible, an RO instance
5050
otherwise.
51-
* Mode.PREFER_RO chooses an RO instance, if possible, RW instance
51+
* `Mode.PREFER_RO` chooses an RO instance, if possible, an RW instance
5252
otherwise.
53-
All requests that are guaranteed to write (insert, replace, delete,
54-
upsert, update) use RW mode by default. select uses ANY by default. You
55-
can set the mode explicitly. call, eval, execute and ping requests
53+
All requests that guarantee to write data (insert, replace, delete,
54+
upsert, update) use the RW mode by default.
55+
The select request uses `ANY` by default. You
56+
can set the mode explicitly. The call, eval, execute, and ping requests
5657
require to set the mode explicitly.
5758

5859
Example:
@@ -69,35 +70,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6970
```
7071

7172
### Changed
72-
- **Breaking**: drop Python 2 support (PR #207).
73-
- **Breaking**: change binary types encode/decode for Python 3
74-
to support working with varbinary (PR #211, #105).
75-
With Python 2 the behavior of the connector remains the same.
73+
- **Breaking change**: Python 2 support dropped (PR #207).
74+
- **Breaking change**: `encode`/`decode` binary types for Python 3 changed
75+
to support working with `varbinary` (PR #211, #105).
76+
With Python 2, the behavior of the connector remains the same.
7677

7778
Before this patch:
7879

79-
* encoding="utf-8" (default)
80+
* `encoding="utf-8"` (default)
8081

8182
| Python 3 | -> | Tarantool | -> | Python 3 |
8283
|----------|----|--------------------|----|----------|
8384
| str | -> | mp_str (string) | -> | str |
8485
| bytes | -> | mp_str (string) | -> | str |
8586
| | | mp_bin (varbinary) | -> | bytes |
8687

87-
* encoding=None
88+
* `encoding=None`
8889

8990
| Python 3 | -> | Tarantool | -> | Python 3 |
9091
|----------|----|--------------------|----|----------|
9192
| bytes | -> | mp_str (string) | -> | bytes |
9293
| str | -> | mp_str (string) | -> | bytes |
9394
| | | mp_bin (varbinary) | -> | bytes |
9495

95-
Using bytes as key was not supported by several methods (delete,
96-
update, select).
96+
Several method (delete, update, select) did not support
97+
using `bytes` as key.
9798

9899
After this patch:
99100

100-
* encoding="utf-8" (default)
101+
* `encoding="utf-8"` (default)
101102

102103
| Python 3 | -> | Tarantool | -> | Python 3 |
103104
|----------|----|--------------------|----|----------|
@@ -112,13 +113,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
112113
| str | -> | mp_str (string) | -> | bytes |
113114
| | | mp_bin (varbinary) | -> | bytes |
114115

115-
Using bytes as key are now supported by all methods.
116+
All methods now support using `bytes` as key.
116117

117-
Thus, encoding="utf-8" connection may be used to work with
118-
utf-8 strings and varbinary and encodine=None connection
119-
may be used to work with non-utf-8 strings.
118+
Thus, an `encoding="utf-8"` connection may be used to work with
119+
UTF-8 strings and `varbinary`, and an `encoding=None` connection
120+
may be used to work with non-UTF-8 strings.
120121

121-
- Clarify license of the project (BSD-2-Clause) (PR #210, #197).
122+
- Clarify the license of the project (BSD-2-Clause) (PR #210, #197).
122123
- Migrate CI to GitHub Actions (PR #213, PR #216, #182).
123124
- Various improvements and fixes in README (PR #210, PR #215).
124125

@@ -141,15 +142,15 @@ the dependency on the msgpack library.
141142

142143
### Added
143144
- Support msgpack 1.0.0 (#155, PR #173).
144-
- SQL support (<connection>.execute() method) (#159, PR #161).
145-
- Allow to receive a Tarantool tuple as a Python tuple, not a list, with
146-
use_list=False connection option (#166, PR #161).
145+
- SQL support (the method `<connection>.execute()`) (#159, PR #161).
146+
- Allow receiving a Tarantool tuple as a Python tuple, not a list, with
147+
the `use_list=False` connection option (#166, PR #161).
147148
- Support the Database API (PEP-0249) (PR #161).
148149

149150
### Changed
150151
- Various improvements in README (PR #147, PR #151, PR #180).
151152

152153
### Fixed
153-
- Support encoding=None connections (PR #172).
154+
- Support `encoding=None` connections (PR #172).
154155
- Various improvements and fixes in tests (8ff9a3f, bd37703, PR #165,
155156
#178, PR #179, PR #181).

INSTALL

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
Installing tarantool-python
22
===========================
33

4-
The simplest (and recommended) way to install tarantool-python
4+
Here is the simplest (and recommended) way to install tarantool-python.
55

6-
using `pip`::
6+
Using `pip`::
77

88
$ pip install tarantool
99

10-
or `easy_install`::
10+
Using `easy_install`::
1111

1212
$ easy_install tarantool
1313

1414

15-
You can also download a source tarball and install the package using distutils script::
15+
You can also download the source tarball and install the package using distutils script::
1616

1717
# python setup.py install

README.rst

+41-35
Original file line numberDiff line numberDiff line change
@@ -14,35 +14,39 @@ This package is a pure-python client library for `Tarantool`_.
1414
.. image:: https://github.com/tarantool/tarantool-python/actions/workflows/testing.yml/badge.svg?branch=master
1515
:target: https://github.com/tarantool/tarantool-python/actions/workflows/testing.yml
1616

17-
Download and Install
17+
Download and install
1818
--------------------
1919

20-
The recommended way to install ``tarantool`` package is using PIP
21-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
20+
With pip (recommended)
21+
^^^^^^^^^^^^^^^^^^^^^^
2222

23-
For Tarantool version < 1.6.0 you must get ``0.3.*`` connector version::
23+
The recommended way to install the ``tarantool`` package is using ``pip``.
24+
25+
For Tarantool version < 1.6.0, get the ``0.3.*`` connector version::
2426

2527
$ pip install tarantool\<0.4
2628

27-
For later Tarantool use version ``0.5.*`` connector version::
29+
For a later Tarantool version, get the ``0.5.*`` connector version::
2830

2931
$ pip install tarantool\>0.4
3032

31-
You can also download zip archive, unpack it and run
32-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33+
ZIP archive
34+
^^^^^^^^^^^
3335

34-
.. code-block:: console
36+
You can also download zip archive, unpack it and run::
3537

3638
$ python setup.py install
3739

38-
To install development version of the package using pip
39-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
40+
Development version
41+
^^^^^^^^^^^^^^^^^^^
42+
43+
You can also install the development version of the package using ``pip``.
4044

41-
For Tarantool version < 1.6.0 you must get ``stable`` branch::
45+
For Tarantool version < 1.6.0, get the ``stable`` branch::
4246

4347
$ pip install git+https://github.com/tarantool/tarantool-python.git@stable
4448

45-
For later Tarantool use ``master`` branch::
49+
For a later Tarantool version, use the ``master`` branch::
4650

4751
$ pip install git+https://github.com/tarantool/tarantool-python.git@master
4852

@@ -51,41 +55,42 @@ For later Tarantool use ``master`` branch::
5155
What is Tarantool?
5256
------------------
5357

54-
`Tarantool`_ is a NoSQL database running inside a Lua program. It combines the
55-
network programming power of Node.JS with data persistency capabilities of
56-
Redis. It's open source, `BSD-2-Clause`_ licensed.
58+
`Tarantool`_ is an in-memory NoSQL database with a Lua application server on board.
59+
It combines the network programming power of Node.JS
60+
with data persistency capabilities of Redis.
61+
It's open-source, licensed under `BSD-2-Clause`_.
5762

5863
Features
5964
--------
6065

6166
* ANSI SQL, including views, joins, referential and check constraints
62-
* Lua packages for non-blocking I/O, fibers and HTTP
63-
* MsgPack data format and MsgPack based client-server protocol
67+
* Lua packages for non-blocking I/O, fibers, and HTTP
68+
* MsgPack data format and MsgPack-based client-server protocol
6469
* Two data engines:
6570

66-
* memtx - the in-memory storage engine with optional persistence
67-
* vinyl - the on-disk storage engine to use with large data sets
71+
* memtx in-memory storage engine with optional persistence
72+
* vinyl on-disk storage engine to use with larger data sets
6873

69-
* secondary key and index iterators support (can be non-unique and composite)
70-
* multiple index types: HASH, BITSET, TREE, RTREE
71-
* asynchronous master-master replication
72-
* authentication and access control
74+
* Secondary key and index iterator support (can be non-unique and composite)
75+
* Multiple index types: HASH, BITSET, TREE, RTREE
76+
* Asynchronous master-master replication
77+
* Authentication and access control
7378

7479
See More
7580
^^^^^^^^
7681

77-
* `Tarantool Homepage`_
78-
* `Tarantool at Github`_
79-
* `Tarantool User Guide`_
80-
* `Client-server Protocol Specification`_
82+
* `Tarantool homepage`_
83+
* `Tarantool on GitHub`_
84+
* `Tarantool documentation`_
85+
* `Client-server protocol specification`_
8186

8287
NOTE
8388
^^^^
8489

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

87-
Look at `asynctnt`_ for asynchronous Python driver based on asyncio. See
88-
also the `feature comparison table`_.
92+
If you're looking for an asynchronous Python driver based on ``asyncio``,
93+
consider using `asynctnt`_ . See also the `feature comparison table`_.
8994

9095
Run tests
9196
^^^^^^^^^
@@ -98,20 +103,21 @@ On Linux:
98103
99104
On Windows:
100105

101-
* Setup a Linux machine with installed tarantool (called ``remote`` later).
102-
* (on ``remote``) Copy ``test/suites/lib/tarantool_python_ci.lua`` to
106+
* Setup a Linux machine with Tarantool installed.
107+
This machine will be referred to as ``remote`` in this instruction.
108+
* (On ``remote``) Copy ``test/suites/lib/tarantool_python_ci.lua`` to
103109
``/etc/tarantool/instances.available``.
104-
* (on ``remote``) Run ``tarantoolctl start tarantool_python_ci``.
110+
* (On ``remote``) Run ``tarantoolctl start tarantool_python_ci``.
105111
* Set the following environment variables:
106112
* ``REMOTE_TARANTOOL_HOST=...``,
107113
* ``REMOTE_TARANTOOL_CONSOLE_PORT=3302``.
108114
* Run ``python setup.py test``.
109115

110116
.. _`Tarantool`:
111117
.. _`Tarantool Database`:
112-
.. _`Tarantool Homepage`: https://tarantool.io
113-
.. _`Tarantool at Github`: https://github.com/tarantool/tarantool
114-
.. _`Tarantool User Guide`: https://www.tarantool.io/en/doc/latest/
118+
.. _`Tarantool homepage`: https://tarantool.io
119+
.. _`Tarantool on GitHub`: https://github.com/tarantool/tarantool
120+
.. _`Tarantool documentation`: https://www.tarantool.io/en/doc/latest/
115121
.. _`Client-server protocol specification`: https://www.tarantool.io/en/doc/latest/dev_guide/internals/box_protocol/
116122
.. _`BSD-2-Clause`: https://opensource.org/licenses/BSD-2-Clause
117123
.. _`asynctnt`: https://github.com/igorcoding/asynctnt

0 commit comments

Comments
 (0)