Skip to content

Commit 3bb9a44

Browse files
dmelnichukisapego
authored andcommitted
NBL-21: Python thin: changed packet name
This closes #195
1 parent e2ea65f commit 3bb9a44

105 files changed

Lines changed: 638 additions & 958 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
1-
# ignite-python-client
2-
Apache Ignite thin (binary protocol) client, written in Python 3.
1+
# pygridgain
2+
GridGain Community Edition thin (binary protocol) client, written in Python 3.
33

44
## Prerequisites
55

66
- Python 3.4 or above (3.6 is tested),
7-
- Access to Apache Ignite node, local or remote. The current thin client
8-
version was tested on Apache Ignite 2.7.0 (binary client protocol 1.2.0).
7+
- Access to GridGain node, local or remote. The current thin client
8+
version was tested on GridGain CE 8.7 (binary client protocol versions
9+
1.2.0 to 1.4.0).
910

1011
## Installation
1112

1213
#### *for end user*
13-
If you only want to use the `pyignite` module in your project, do:
14+
If you only want to use the `pygridgain` module in your project, do:
1415
```
15-
$ pip install pyignite
16+
$ pip install pygridgain
1617
```
1718

1819
#### *for developer*
1920
If you want to run tests, examples or build documentation, clone
2021
the whole repository:
2122
```
22-
$ git clone git@github.com:apache/ignite.git
23-
$ cd ignite/modules/platforms/python
23+
$ git clone git@github.com:gridgain/gridgain.git
24+
$ cd gridgain/modules/platforms/python
2425
$ pip install -e .
2526
```
2627

27-
This will install the repository version of `pyignite` into your environment
28+
This will install the repository version of `pygridgain` into your environment
2829
in so-called “develop” or “editable” mode. You may read more about
2930
[editable installs](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)
3031
in the `pip` manual.
@@ -38,38 +39,38 @@ $ pip install -r requirements/<your task>.txt
3839
You may also want to consult the `setuptools` manual about using `setup.py`.
3940

4041
## Documentation
41-
[The package documentation](https://apache-ignite-binary-protocol-client.readthedocs.io)
42-
is available at *RTD* for your convenience.
42+
[The package documentation](https://pygridgain.readthedocs.io) is available
43+
at *RTD* for your convenience.
4344

4445
If you want to build the documentation from source, do the developer
4546
installation as described above, then run the following commands:
4647
```
47-
$ cd ignite/modules/platforms/python
48+
$ cd gridgain/modules/platforms/python
4849
$ pip install -r requirements/docs.txt
4950
$ cd docs
5051
$ make html
5152
```
5253

53-
Then open `ignite/modules/platforms/python/docs/generated/html/index.html`
54+
Then open `gridgain/modules/platforms/python/docs/generated/html/index.html`
5455
in your browser.
5556

5657
## Examples
57-
Some examples of using pyignite are provided in
58-
`ignite/modules/platforms/python/examples` folder. They are extensively
58+
Some examples of using pygridgain are provided in
59+
`gridgain/modules/platforms/python/examples` folder. They are extensively
5960
commented in the
60-
[Examples of usage](https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/examples.html)
61+
[Examples of usage](https://pygridgain.readthedocs.io/en/latest/examples.html)
6162
section of the documentation.
6263

63-
This code implies that it is run in the environment with `pyignite` package
64-
installed, and Apache Ignite node is running on localhost:10800.
64+
This code implies that it is run in the environment with `pygridgain` package
65+
installed, and GridGain node is running on localhost:10800.
6566

6667
## Testing
6768
Run
6869
```
69-
$ cd ignite/modules/platforms/python
70+
$ cd gridgain/modules/platforms/python
7071
$ python setup.py pytest
7172
```
7273

73-
*NB!* All tests require Apache Ignite node running on localhost:10800.
74+
*NB!* All tests require GridGain node running on localhost:10800.
7475
If you need to change the connection parameters, see the documentation on
75-
[testing](https://apache-ignite-binary-protocol-client.readthedocs.io/en/latest/readme.html#testing).
76+
[testing](https://pygridgain.readthedocs.io/en/latest/readme.html#testing).

docs/conf.py

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919

2020
# -- Project information -----------------------------------------------------
2121

22-
project = 'Apache Ignite binary client Python API'
23-
copyright = '2018, Apache Software Foundation (ASF)'
22+
project = 'GridGain binary client Python API'
23+
copyright = '2018-2019, GridGain Community Edition License'
2424
author = 'Dmitry Melnichuk'
2525

2626
# The short X.Y version
@@ -104,7 +104,7 @@
104104
# -- Options for HTMLHelp output ---------------------------------------------
105105

106106
# Output file base name for HTML help builder.
107-
htmlhelp_basename = 'ApacheIgnitebinaryclientPythonAPIdoc'
107+
htmlhelp_basename = 'GridGainbinaryclientPythonAPIdoc'
108108

109109

110110
# -- Options for LaTeX output ------------------------------------------------
@@ -131,8 +131,13 @@
131131
# (source start file, target name, title,
132132
# author, documentclass [howto, manual, or own class]).
133133
latex_documents = [
134-
(master_doc, 'ApacheIgnitebinaryclientPythonAPI.tex', 'Apache Ignite binary client Python API Documentation',
135-
'Apache Software Foundation (ASF)', 'manual'),
134+
(
135+
master_doc,
136+
'GridGainbinaryclientPythonAPI.tex',
137+
'GridGain binary client Python API Documentation',
138+
'GridGain Community Edition License',
139+
'manual'
140+
),
136141
]
137142

138143

@@ -141,8 +146,13 @@
141146
# One entry per manual page. List of tuples
142147
# (source start file, name, description, authors, manual section).
143148
man_pages = [
144-
(master_doc, 'apacheignitebinaryclientpythonapi', 'Apache Ignite binary client Python API Documentation',
145-
[author], 1)
149+
(
150+
master_doc,
151+
'gridgainbinaryclientpythonapi',
152+
'GridGain binary client Python API Documentation',
153+
[author],
154+
1
155+
)
146156
]
147157

148158

@@ -152,9 +162,15 @@
152162
# (source start file, target name, title, author,
153163
# dir menu entry, description, category)
154164
texinfo_documents = [
155-
(master_doc, 'ApacheIgnitebinaryclientPythonAPI', 'Apache Ignite binary client Python API Documentation',
156-
author, 'ApacheIgnitebinaryclientPythonAPI', 'One line description of project.',
157-
'Miscellaneous'),
165+
(
166+
master_doc,
167+
'GridGainbinaryclientPythonAPI',
168+
'GridGain binary client Python API Documentation',
169+
author,
170+
'GridGainbinaryclientPythonAPI',
171+
'GridGain binary client Python API',
172+
'Miscellaneous'
173+
),
158174
]
159175

160176

docs/datatypes/cache_props.rst

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
.. Licensed to the Apache Software Foundation (ASF) under one or more
2-
contributor license agreements. See the NOTICE file distributed with
3-
this work for additional information regarding copyright ownership.
4-
The ASF licenses this file to You under the Apache License, Version 2.0
5-
(the "License"); you may not use this file except in compliance with
6-
the License. You may obtain a copy of the License at
1+
.. Copyright 2019 GridGain Systems, Inc. and Contributors.
72
8-
.. http://www.apache.org/licenses/LICENSE-2.0
3+
.. Licensed under the GridGain Community Edition License (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
.. https://www.gridgain.com/products/software/community-edition/gridgain-community-edition-license
98
109
.. Unless required by applicable law or agreed to in writing, software
1110
distributed under the License is distributed on an "AS IS" BASIS,
@@ -19,19 +18,19 @@
1918
Cache Properties
2019
================
2120

22-
The :mod:`~pyignite.datatypes.prop_codes` module contains a list of ordinal
21+
The :mod:`~pygridgain.datatypes.prop_codes` module contains a list of ordinal
2322
values, that represent various cache settings.
2423

25-
Please refer to the `Apache Ignite Data Grid`_ documentation on cache
24+
Please refer to the `GridGain Data Grid`_ documentation on cache
2625
synchronization, rebalance, affinity and other cache configuration-related
2726
matters.
2827

2928
+---------------------------------------+----------+----------+-------------------------------------------------------+
3029
| Property | Ordinal | Property | Description |
3130
| name | value | type | |
3231
+=======================================+==========+==========+=======================================================+
33-
| Read/write cache properties, used to configure cache via :py:meth:`~pyignite.client.Client.create_cache` or |
34-
| :py:meth:`~pyignite.client.Client.get_or_create_cache` |
32+
| Read/write cache properties, used to configure cache via :py:meth:`~pygridgain.client.Client.create_cache` or |
33+
| :py:meth:`~pygridgain.client.Client.get_or_create_cache` |
3534
+---------------------------------------+----------+----------+-------------------------------------------------------+
3635
| PROP_NAME | 0 | str | Cache name. This is the only *required* property. |
3736
+---------------------------------------+----------+----------+-------------------------------------------------------+
@@ -96,7 +95,7 @@ matters.
9695
+---------------------------------------+----------+----------+-------------------------------------------------------+
9796
| PROP_STATISTICS_ENABLED | 406 | bool | Statistics enabled |
9897
+---------------------------------------+----------+----------+-------------------------------------------------------+
99-
| Read-only cache properties. Can not be set, but only retrieved via :py:meth:`~pyignite.cache.Cache.settings` |
98+
| Read-only cache properties. Can not be set, but only retrieved via :py:meth:`~pygridgain.cache.Cache.settings` |
10099
+---------------------------------------+----------+----------+-------------------------------------------------------+
101100
| PROP_INVALIDATE | -1 | bool | Invalidate |
102101
+---------------------------------------+----------+----------+-------------------------------------------------------+
@@ -130,7 +129,7 @@ Query field
130129
- `is_key_field`: (optional) boolean value, `False` by default,
131130
- `is_notnull_constraint_field`: boolean value,
132131
- `default_value`: (optional) anything that can be converted to `type_name`
133-
type. `None` (:py:class:`~pyignite.datatypes.null_object.Null`) by default,
132+
type. `None` (:py:class:`~pygridgain.datatypes.null_object.Null`) by default,
134133
- `precision` − (optional) decimal precision: total number of digits
135134
in decimal value. Defaults to -1 (use cluster default). Ignored for
136135
non-decimal SQL types (other than `java.math.BigDecimal`),
@@ -160,4 +159,4 @@ A dict of the following format:
160159
- `type_name`: name of the complex object,
161160
- `affinity_key_field_name`: name of the affinity key field.
162161

163-
.. _Apache Ignite Data Grid: https://apacheignite.readme.io/docs/data-grid
162+
.. _GridGain Data Grid: https://www.gridgain.com/technology/in-memory-computing-platform/data-grid

0 commit comments

Comments
 (0)