|
2 | 2 |
|
3 | 3 | ## Introduction |
4 | 4 |
|
5 | | -`ndb` is a client library for use with [Google Cloud Datastore][0]. |
6 | | -It was designed specifically to be used from within the |
7 | | -[Google App Engine][1] Python runtime. |
| 5 | +This is a Python 3 version of the `ndb` client library for use with |
| 6 | +[Google Cloud Datastore][0]. |
8 | 7 |
|
9 | | -## Overview |
10 | | - |
11 | | -Learn how to use the `ndb` library by visiting the Google Cloud Platform |
12 | | -[documentation][2]. |
| 8 | +The original Python 2 version of `ndb` was designed specifically for the |
| 9 | +[Google App Engine][1] `python27` runtime and can be found at |
| 10 | +https://github.com/GoogleCloudPlatform/datastore-ndb-python. This version of |
| 11 | +`ndb` is designed for the [Google App Engine Python 3 runtime][2], and will |
| 12 | +run on other Python 3 platforms as well. |
13 | 13 |
|
14 | 14 | [0]: https://cloud.google.com/datastore |
15 | 15 | [1]: https://cloud.google.com/appengine |
16 | | -[2]: https://cloud.google.com/appengine/docs/python/ndb/ |
17 | | - |
18 | | -## Installation |
| 16 | +[2]: https://cloud.google.com/appengine/docs/standard/python3/ |
19 | 17 |
|
20 | | -Install this library in a virtualenv using pip. virtualenv is a tool to create isolated Python environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions. |
| 18 | +## Release Status |
21 | 19 |
|
22 | | -With virtualenv, it's possible to install this library without needing system install permissions, and without clashing with the installed system dependencies. |
| 20 | +This version of the client is not yet officially released (it is in a |
| 21 | +pre-Alpha state) and is still under active development. |
23 | 22 |
|
24 | 23 | ### Supported Python Versions |
25 | 24 | Python >= 3.6 |
26 | | - |
27 | | -As this package is designed to work in the [AppEngine runtime](https://cloud.google.com/appengine/docs/python/) Python 3.6+ are supported. |
28 | | - |
29 | | -### Mac/Linux |
30 | | -``` |
31 | | -pip install virtualenv |
32 | | -virtualenv <your-env> |
33 | | -source <your-env>/bin/activate |
34 | | -<your-env>/bin/pip install google-cloud-ndb |
35 | | -``` |
36 | | - |
37 | | -### Windows |
38 | | -``` |
39 | | -pip install virtualenv |
40 | | -virtualenv <your-env> |
41 | | -<your-env>\Scripts\activate |
42 | | -<your-env>\Scripts\pip.exe install google-cloud-ndb |
43 | | -``` |
0 commit comments