Skip to content

Commit b95d4cc

Browse files
authored
Update readme to address psycopg2 installation issues (#19)
1 parent 560a95e commit b95d4cc

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Timescale Vector
22

3+
34
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
45

56
PostgreSQL++ for AI Applications.
@@ -39,6 +40,16 @@ keys. You can install that with:
3940
pip install python-dotenv
4041
```
4142

43+
If you run into installation errors related to the psycopg2 package, you
44+
will need to install some prerequisites. The timescale-vector package
45+
explicitly depends on psycopg2 (the non-binary version). This adheres to
46+
[the advice provided by
47+
psycopg2](https://www.psycopg.org/docs/install.html#psycopg-vs-psycopg-binary).
48+
Building psycopg from source [requires a few prerequisites to be
49+
installed](https://www.psycopg.org/docs/install.html#build-prerequisites).
50+
Make sure these are installed before trying to
51+
`pip install timescale_vector`.
52+
4253
## Basic usage
4354

4455
First, import all the necessary libraries:

nbs/index.ipynb

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@
4747
"\n",
4848
"```sh\n",
4949
"pip install python-dotenv\n",
50-
"```"
50+
"```\n",
51+
"\n",
52+
"If you run into installation errors related to the psycopg2 package, you will need to install some prerequisites. The timescale-vector package explicitly depends on psycopg2 (the non-binary version). This adheres to [the advice provided by psycopg2](https://www.psycopg.org/docs/install.html#psycopg-vs-psycopg-binary). Building psycopg from source [requires a few prerequisites to be installed](https://www.psycopg.org/docs/install.html#build-prerequisites). Make sure these are installed before trying to `pip install timescale_vector`."
5153
]
5254
},
5355
{
@@ -1681,6 +1683,10 @@
16811683
"display_name": "python3",
16821684
"language": "python",
16831685
"name": "python3"
1686+
},
1687+
"language_info": {
1688+
"name": "python",
1689+
"version": "3.10.11"
16841690
}
16851691
},
16861692
"nbformat": 4,

0 commit comments

Comments
 (0)