https://github.com/sajith4u/gazettequery
RAG based application for analyzing Sri Lankan government gazette files
https://github.com/sajith4u/gazettequery
gazette openapi rag
Last synced: 8 months ago
JSON representation
RAG based application for analyzing Sri Lankan government gazette files
- Host: GitHub
- URL: https://github.com/sajith4u/gazettequery
- Owner: sajith4u
- Created: 2025-07-01T11:37:58.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-07-03T06:46:07.000Z (9 months ago)
- Last Synced: 2025-07-18T06:30:26.935Z (8 months ago)
- Topics: gazette, openapi, rag
- Language: Python
- Homepage:
- Size: 3.23 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Setup Instructions
Follow these steps to get the project up and running on your local machine.
### 1. Clone the Repository (if applicable)
If this project is hosted on a version control system (like Git), clone it to your local machine:
git clone git@github.com:sajith4u/GazetteQuery.git
### 2. Create a Virtual Environment
It's highly recommended to use a virtual environment to manage project dependencies and avoid conflicts with other Python projects.
python3 -m venv venv
### 3. Activate the Virtual Environment
Before installing dependencies or running the application, activate your virtual environment:
* **On macOS/Linux:**
```
source venv/bin/activate
```
* **On Windows:**
```
.\venv\Scripts\activate
```
You should see `(venv)` at the beginning of your terminal prompt, indicating the environment is active.
### 4. Install Dependencies
With your virtual environment activated, install all necessary packages using the `requirements.txt` file:
pip3 install -r requirements.txt
## How to Run the Project
Once the setup is complete, you can run the application from your terminal:
1. **Ensure your virtual environment is active.** (See Step 3 in Setup Instructions)
2. **Run the main application script:**
```
python3 main.py
```
The application will:
* Load and index the documents from your `data` directory.
* Prompt you to enter a query.
* Provide answers based on the content of your gazette files, along with the source documents.
* Type `exit` or `quit` to stop the application.
## Screenshots
### Example: Project Structure
### Example: Running the Application
Chroma DB Demo (chroma-demo.py)
