Skip to content

Commit 0f7893d

Browse files
authored
GG-25840: Updated README (#4)
1 parent fb9dcb1 commit 0f7893d

1 file changed

Lines changed: 30 additions & 8 deletions

File tree

README.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,21 @@ GridGain Community Edition thin (binary protocol) client, written in Python 3.
1010

1111
## Installation
1212

13-
#### *for end user*
14-
If you only want to use the `pygridgain` module in your project, do:
13+
### From repository
14+
This is a recommended way for users. If you only want to use the `pygridgain`
15+
module in your project, do:
1516
```
1617
$ pip install pygridgain
1718
```
1819

19-
#### *for developer*
20-
If you want to run tests, examples or build documentation, clone
21-
the whole repository:
22-
```
23-
$ git clone git@github.com:gridgain/gridgain.git
24-
$ cd gridgain/modules/platforms/python
20+
### From sources
21+
This way is more suitable for developers or if you install client from zip archive.
22+
1. Download and/or unzip GridGain Python client sources to `gridgain_client_path`
23+
2. Go to `gridgain_client_path` folder
24+
3. Execute `pip install -e .`
25+
26+
```bash
27+
$ cd <gridgain_client_path>
2528
$ pip install -e .
2629
```
2730

@@ -38,6 +41,25 @@ $ pip install -r requirements/<your task>.txt
3841

3942
You may also want to consult the `setuptools` manual about using `setup.py`.
4043

44+
### Updating from older version
45+
46+
To upgrade an existing package, use the following command:
47+
```
48+
pip install --upgrade pygridgain
49+
```
50+
51+
To install the latest version of a package:
52+
53+
```
54+
pip install pygridgain
55+
```
56+
57+
To install a specific version:
58+
59+
```
60+
pip install pygridgain==1.0.0
61+
```
62+
4163
## Documentation
4264
[The package documentation](https://pygridgain.readthedocs.io) is available
4365
at *RTD* for your convenience.

0 commit comments

Comments
 (0)