| Name | paginx JSON |
| Version |
0.0.27
JSON |
| download |
| home_page | None |
| Summary | An assistant helping you to index webpages into structured datasets. |
| upload_time | 2024-07-23 13:49:41 |
| maintainer | None |
| docs_url | None |
| author | Ben Selleslagh |
| requires_python | <3.13,>=3.12 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PAGINX
  
Paginx is an innovative Python-based project that leverages the power of Large Language Models (LLMs) and Retrieval-Augmented Generation (RAG) to provide intelligent question-answering capabilities for any given website. By simply entering a website URL, users can interact with an AI assistant that can answer questions and provide insights based on the content of the website.
## Setting Up a PostgreSQL instance with the pgvector Extension
To store the uploaded data for later retrieval (for example during RAG), you need to set up a PostgreSQL database with the pgvector extension enabled. This chapter guides you through the steps to install PostgreSQL, enable the pgvector extension, create a new database, and store the connection string as a URL. Alternatively, you can use hosted PostgreSQL instances provided by many cloud providers.
### 1. Install PostgreSQL and pgvector Extension
**Using Docker**
1. Pull the PostgreSQL image with pgvector:
```sh
docker pull ankane/pgvector
```
2. Run the PostgreSQL container with the pgvector extension enabled:
```sh
docker run -d --name paginx -e POSTGRES_PASSWORD=mysecretpassword -p 5432:5432 -e PG_EXTENSIONS="pgvector" ankane/pgvector
```
**Manual Installation**
If you prefer to install PostgreSQL and pgvector manually, please follow the instructions provided in the official documentation:
- [PostgreSQL Installation](https://www.postgresql.org/download/)
- [pgvector Installation](https://github.com/ankane/pgvector)
### 2. Create a New Database
Once you have PostgreSQL running with pgvector enabled, you need to create a new database for our application. You can do this by connecting to your PostgreSQL instance and executing the following SQL commands
Create a new database named `paginx` (you can choose a different name if you prefer):
```sql
CREATE DATABASE paginx;
```
Connect to the `paginx` database:
```sql
\c paginx;
```
Enable the pgvector extension for the `paginx` database:
```sql
CREATE EXTENSION IF NOT EXISTS vector;
```
### 3. Store the Connection String
After creating the database, you need to store the connection string as an enviroment variable named ```database_url```. This connection string will be used by paginx to connect to the database.
The envrioment variable can be set using the following command:
```sh
export database_url="postgresql://postgres:mysecretpassword@localhost/paginx"
```
### 4. Using a Hosted PostgreSQL Instance
If you prefer to use a hosted PostgreSQL instance, you can create a new database and store the connection string as a URL. Make sure to enable the pgvector extension for the hosted database.
Raw data
{
"_id": null,
"home_page": null,
"name": "paginx",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Ben Selleslagh",
"author_email": "ben@dataframe.be",
"download_url": "https://files.pythonhosted.org/packages/66/d2/6b80c58bc666663994b8e94f26a4063ceef43a184c3be6b14cfffb79cc5f/paginx-0.0.27.tar.gz",
"platform": null,
"description": "# PAGINX\n\n  \n\n Paginx is an innovative Python-based project that leverages the power of Large Language Models (LLMs) and Retrieval-Augmented Generation (RAG) to provide intelligent question-answering capabilities for any given website. By simply entering a website URL, users can interact with an AI assistant that can answer questions and provide insights based on the content of the website.\n\n## Setting Up a PostgreSQL instance with the pgvector Extension\nTo store the uploaded data for later retrieval (for example during RAG), you need to set up a PostgreSQL database with the pgvector extension enabled. This chapter guides you through the steps to install PostgreSQL, enable the pgvector extension, create a new database, and store the connection string as a URL. Alternatively, you can use hosted PostgreSQL instances provided by many cloud providers.\n\n### 1. Install PostgreSQL and pgvector Extension\n**Using Docker**\n1.\tPull the PostgreSQL image with pgvector:\n```sh\ndocker pull ankane/pgvector\n```\n\n2.\tRun the PostgreSQL container with the pgvector extension enabled:\n```sh\ndocker run -d --name paginx -e POSTGRES_PASSWORD=mysecretpassword -p 5432:5432 -e PG_EXTENSIONS=\"pgvector\" ankane/pgvector\n```\n\n**Manual Installation**\n\nIf you prefer to install PostgreSQL and pgvector manually, please follow the instructions provided in the official documentation:\n\n- [PostgreSQL Installation](https://www.postgresql.org/download/)\n- [pgvector Installation](https://github.com/ankane/pgvector)\n\n### 2. Create a New Database\nOnce you have PostgreSQL running with pgvector enabled, you need to create a new database for our application. You can do this by connecting to your PostgreSQL instance and executing the following SQL commands\n\n\nCreate a new database named `paginx` (you can choose a different name if you prefer):\n```sql\nCREATE DATABASE paginx;\n```\n\nConnect to the `paginx` database:\n```sql\n\\c paginx;\n```\n\nEnable the pgvector extension for the `paginx` database:\n```sql\nCREATE EXTENSION IF NOT EXISTS vector;\n```\n\n### 3. Store the Connection String\nAfter creating the database, you need to store the connection string as an enviroment variable named ```database_url```. This connection string will be used by paginx to connect to the database.\n\n\nThe envrioment variable can be set using the following command:\n```sh\nexport database_url=\"postgresql://postgres:mysecretpassword@localhost/paginx\"\n```\n\n### 4. Using a Hosted PostgreSQL Instance\nIf you prefer to use a hosted PostgreSQL instance, you can create a new database and store the connection string as a URL. Make sure to enable the pgvector extension for the hosted database.\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An assistant helping you to index webpages into structured datasets.",
"version": "0.0.27",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27e12afb57163334c22568f99372d1c2bdbe7d27f340aecd4f9c108cfe1bc723",
"md5": "78ff47febe1c057a0d1d9997ef653f35",
"sha256": "192dc5891048a7d69842568d309dce13796ac823df4be134c09ca3b6a5cfab58"
},
"downloads": -1,
"filename": "paginx-0.0.27-py3-none-any.whl",
"has_sig": false,
"md5_digest": "78ff47febe1c057a0d1d9997ef653f35",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.12",
"size": 21873,
"upload_time": "2024-07-23T13:49:39",
"upload_time_iso_8601": "2024-07-23T13:49:39.997584Z",
"url": "https://files.pythonhosted.org/packages/27/e1/2afb57163334c22568f99372d1c2bdbe7d27f340aecd4f9c108cfe1bc723/paginx-0.0.27-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66d26b80c58bc666663994b8e94f26a4063ceef43a184c3be6b14cfffb79cc5f",
"md5": "48a430f9fac73dbaf5241e7d063be8cd",
"sha256": "bb8b0a2b16408b5c3dbe927e9fee1a37815ae5602c4f179a156351917a7fb2b7"
},
"downloads": -1,
"filename": "paginx-0.0.27.tar.gz",
"has_sig": false,
"md5_digest": "48a430f9fac73dbaf5241e7d063be8cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.12",
"size": 18441,
"upload_time": "2024-07-23T13:49:41",
"upload_time_iso_8601": "2024-07-23T13:49:41.267872Z",
"url": "https://files.pythonhosted.org/packages/66/d2/6b80c58bc666663994b8e94f26a4063ceef43a184c3be6b14cfffb79cc5f/paginx-0.0.27.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-23 13:49:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "paginx"
}
