Skip to content

Latest commit

 

History

History
113 lines (80 loc) · 2.67 KB

INSTALL.md

File metadata and controls

113 lines (80 loc) · 2.67 KB
Raw

Installation

You can install Haverscript directly from the GitHub repository using pip.

Here's how to set up Haverscript:

  1. First, create and activate a Python virtual environment if you haven’t already:
python3 -m venv venv
source venv/bin/activate  # On Windows: .\venv\Scripts\activate
  1. Install Haverscript directly from the GitHub repository:
pip install "haverscript @ git+https://github.com/andygill/haverscript.git@v0.2.1"

By default, Haverscript comes with only Ollama support. If you want to also install the together.ai API support, you need to use

pip install "haverscript[together] @ git+https://github.com/andygill/haverscript.git@v0.2.1"

In the future, if there’s enough interest, I plan to push Haverscript to PyPI for easier installation.

Download and install

If you are a Haverscript user, then the commands above should work for you.

However, if you want to make changes to Haverscript, you will need to download the repo, and build by hand. I use the following.

git clone git@github.com:andygill/haverscript.git
cd haverscript
python3 -m venv venv
source venv/bin/activate  # On Windows: .\venv\Scripts\activate
pip install -e ".[all]"

Now any local example can be run directly.

python examples/first_example/main.py
> In one sentence, why is the sky blue?

The sky appears blue due to scattering of sunlight by molecules and particles in the Earth's atmosphere.

...

Testing

The unit tests are code fragments to test specific features The e2e tests execute a sub-process, testing the examples. The docs test check the docs are consistent with the given examples.

pytest tests      # run all tests
pytest tests/unit # run unit tests
pytest tests/e2e  # run e2e tests

You can run tests in parallel, using the pytest-xdist package. However, remember ollama will be the bottleneck here.

pytest -n auto

The e2e tests also uses pytest-regressions. The golden output is version controlled.

We use the following models:

  • ollama mistral:v0.3 (f974a74358d6)
  • together.ai meta-llama/Meta-Llama-3-8B-Instruct-Lite
  • ollama llava:v1.6 (8dd30f6b0cb1)

The tests for together need a valid TOGETHER_API_KEY in the environment when run.

If you need to regenerate test output, use

pytest tests/e2e --force-regen

Python versions

We support Python 3.10 to 3.13. We test using the following commands.

rm -Rf venv ; python3.13 -m venv venv
. ./venv/bin/activate
pip install -e ".[all]"
pytest -n auto -v
python --version

and

rm -Rf venv ; python3.13 -m venv venv
. ./venv/bin/activate
pip install -e "."
python examples/first_example/main.py
python --version