NCERT-BOT

Overview

NCERT-BOT is a repository focused on integrating and processing educational content from the NCERT curriculum. This project aims to create a bot that can assist with accessing and querying NCERT books and related educational resources.

Repository Structure

NCERT-BOT/
│
├── BOOKS/
│   └── English_xii/
│
├── RAG/
│   ├── chatbot.py
│   ├── pdf_to_vectordb.py
│   └── requirements.txt
│
├── Results/
│
├── src/
│   ├── selenium_extracts/
│   ├── youtube_extracts/
│   ├── __init__.py
│   └── beautifulsoup.py
│
├── extraction.py
│
├── .gitignore
├── README.md
└── requirements.txt

Installation

1. Clone the Repository

Clone the repository to your local machine:

git clone https://github.com/REDFLAG-bugs/NCERT-BOT.git
cd NCERT-BOT

2. Set Up a Virtual Environment (Optional)

If you want to use a virtual environment, run the following commands:

python -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
conda create --name myenv  # conda environment
conda activate myenv       # activate conda env

3. Install Dependencies

Install the necessary dependencies:

pip install -r requirements.txt

Usage

To run the extraction script:

python extraction.py

This script will process the data according to the logic defined in extraction.py.

Contributing

We welcome contributions to improve the project. Please follow these steps:

1. Fork the repository.

Create a new branch:

git checkout -b feature-branch

2. Commit your changes:

git commit -am 'Add new feature'

3. Push to the branch:

git push origin feature-branch

4. Open a Pull Request.

Contact

For any questions or issues, please contact the contributors:

REDFLAG-bugs
anshumangit2411
saswattulo
akansh30
yashy04