Skip to content

Commit 6693f87

Browse files
committed
docs: Refined installation docs.
1 parent 338eb47 commit 6693f87

File tree

2 files changed

+30
-9
lines changed

2 files changed

+30
-9
lines changed

cln.sh

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/installation.rst

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,35 @@
22
Installation
33
============
44

5-
At the command line::
5+
The Python QuestDB client does not have any additional run-time dependencies and
6+
will run on any version of Python >= 3.7 on most platforms and architectures.
7+
8+
You can install it globally by running::
69

710
python3 -m pip install questdb
11+
12+
13+
Or, from within a virtual environment::
14+
15+
pip install questdb
16+
17+
18+
If you're using poetry, you can add ``questdb`` as a dependency::
19+
20+
poetry add questdb
21+
22+
23+
Verifying the Installation
24+
==========================
25+
26+
If you want to check that you've installed the wheel correctly, you can run the
27+
following statements from a ``python3`` interactive shell:
28+
29+
.. code-block:: python
30+
31+
>>> import questdb.ilp
32+
>>> buf = questdb.ilp.Buffer()
33+
>>> buf.row('test', symbols={'a': 'b'})
34+
<questdb.ilp.Buffer object at 0x104b68240>
35+
>>> str(buf)
36+
'test,a=b\n'

0 commit comments

Comments
 (0)