Skip to content

Commit 4e1b47f

Browse files
committed
quick start docs
1 parent 3a85371 commit 4e1b47f

File tree

3 files changed

+53
-26
lines changed

3 files changed

+53
-26
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ YDB Python SDK
1010
:maxdepth: 3
1111

1212
overview
13+
quickstart
1314
examples
1415
apireference
1516

docs/overview.rst

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,6 @@ Releases and project status are available on Pypi at https://pypi.org/project/yd
1010

1111
The most recent published version of this documentation should be at https://ydb-platform.github.io/ydb-python-sdk.
1212

13-
Installation
14-
------------
15-
16-
Prerequisites
17-
^^^^^^^^^^^^^
18-
19-
* Python 3.8 or higher;
20-
* ``pip`` version 9.0.1 or higher;
21-
22-
If necessary, upgrade your version of ``pip``::
23-
24-
python -m pip install --upgrade pip
25-
26-
If you cannot upgrade `pip` due to a system-owned installation, you can run the example in a virtualenv::
27-
28-
python -m pip install virtualenv
29-
virtualenv venv
30-
source venv/bin/activate
31-
python -m pip install --upgrade pip
32-
33-
Installation via Pypi
34-
^^^^^^^^^^^^^^^^^^^^^
35-
36-
To install YDB Python SDK through Pypi execute the following command::
37-
38-
pip install ydb
3913

4014
Community
4115
---------

docs/quickstart.rst

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
Quick Start
2+
===========
3+
4+
Installation
5+
------------
6+
7+
Prerequisites
8+
^^^^^^^^^^^^^
9+
10+
* Python 3.8 or higher;
11+
* ``pip`` version 9.0.1 or higher;
12+
13+
If necessary, upgrade your version of ``pip``::
14+
15+
python -m pip install --upgrade pip
16+
17+
If you cannot upgrade `pip` due to a system-owned installation, you can run the example in a virtualenv::
18+
19+
python -m pip install virtualenv
20+
virtualenv venv
21+
source venv/bin/activate
22+
python -m pip install --upgrade pip
23+
24+
Installation via Pypi
25+
^^^^^^^^^^^^^^^^^^^^^
26+
27+
To install YDB Python SDK through Pypi execute the following command::
28+
29+
pip install ydb
30+
31+
Usage
32+
-----
33+
34+
Import ydb package:
35+
36+
.. code-block:: python
37+
38+
import ydb
39+
40+
Driver initialization:
41+
42+
.. code-block:: python
43+
44+
endpoint = "grpc://localhost:2136" # your ydb endpoint
45+
database = "/local" # your ydb database
46+
47+
with ydb.Driver(
48+
endpoint=endpoint,
49+
database=database,
50+
credentials=ydb.credentials_from_env_variables(),
51+
) as driver:
52+
driver.wait(timeout=5, fail_fast=True)

0 commit comments

Comments
 (0)