Skip to content

Commit e50469c

Browse files
committed
overview doc added
1 parent 18033cd commit e50469c

File tree

2 files changed

+53
-4
lines changed

2 files changed

+53
-4
lines changed

docs/index.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,17 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to ydb's documentation!
6+
YDB Python SDK
77
===============================
88

99
.. toctree::
10-
:maxdepth: 10
10+
:maxdepth: 3
1111

12+
overview
1213
ydb.rst
1314
examples.rst
1415

1516

16-
17-
1817
Indices and tables
1918
==================
2019

docs/overview.rst

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
Project Homepage
2+
================
3+
4+
YDB Python SDK is hosted on GitHub at https://github.com/ydb-platform/ydb-python-sdk under the ydb-platform organization.
5+
6+
Releases and project status are available on Pypi at https://pypi.org/project/ydb.
7+
8+
The most recent published version of this documentation should be at https://ydb-platform.github.io/ydb-python-sdk.
9+
10+
Installation
11+
============
12+
13+
Prerequisites
14+
-------------
15+
16+
* Python 3.8 or higher;
17+
* `pip` version 9.0.1 or higher;
18+
19+
If necessary, upgrade your version of `pip`:
20+
21+
::
22+
$ python -m pip install --upgrade pip
23+
24+
If you cannot upgrade `pip` due to a system-owned installation, you can run the example in a virtualenv:
25+
26+
::
27+
$ python -m pip install virtualenv
28+
$ virtualenv venv
29+
$ source venv/bin/activate
30+
$ python -m pip install --upgrade pip
31+
32+
Installation via Pypi
33+
---------------------
34+
35+
To install YDB Python SDK through Pypi execute the following command:
36+
37+
::
38+
$ pip install ydb
39+
40+
Community
41+
=========
42+
43+
You can ask your questions in official Telegram chats:
44+
**EN** `Official YDB chat <https://t.me/ydb_en>`_.
45+
**RU** `Official YDB chat <https://t.me/ydb_ru>`_.
46+
47+
48+
Bugs and feature enhancements to YDB Python SDK should be reported on the `GitHub
49+
issue tracker
50+
<https://github.com/ydb-platform/ydb-python-sdk/issues/>`_.

0 commit comments

Comments
 (0)