Installation¶

To install the Rule-based Retrieval package, follow these steps:

Prerequisites¶

Clone the repository:

git clone git@github.com:whyhow-ai/rule-based-retrieval.git
cd rule-based-retrieval

Install the packages:

pip install .

Set the required environment variables:

export OPENAI_API_KEY=<your open ai api key>
export PINECONE_API_KEY=<your pinecone api key>

For a developer installation, use an editable install and include the development dependencies:

pip install -e .[dev]

For ZSH:

pip install -e ".[dev]"

To build and serve the documentation locally, install the documentation dependencies:

pip install -e .[docs]

For ZSH:

pip install -e ".[docs]"

Then, use mkdocs to serve the documentation:

mkdocs serve

Navigate to http://127.0.0.1:8000/ in your browser to view the documentation.

If you encounter any issues during installation, please check the following:

Ensure that you have Python 3.10 or higher installed. You can check your Python version by running python --version in your terminal.
Make sure that you have correctly set the OPENAI_API_KEY and PINECONE_API_KEY environment variables with your respective API keys.
If you are installing from GitHub, ensure that you have cloned the repository correctly and are in the right directory.
If you are using a virtual environment, make sure that it is activated before running the installation commands.
If you still face problems, please open an issue on the GitHub repository with detailed information about the error and your environment setup.