Lute v3

This repo contains code to add support for Khmer parsing to the original lutev3 project here.

Setting up a virtual environment

I recommend setting up a virtual environment for python and running lute from within the virtual environment. My favorite virtual environment manager is pyenv

Installing pyenv

Installing pyenv on debian

$ curl https://pyenv.run | bash

Install pyenv on macos

$ brew install pyenv

Setting up the virtual environment using pyenv

Execute the following commands from this project's root

$ pyenv install 3.9.2               # Install python 3.9.2 using pyenv
$ pyenv virtualenv 3.9.2 lute_khmer # Create a new env "lute_khmer" which uses python 3.9.2
$ pyenv local lute_khmer            # Creates a special file called ".python-version" which automatically sets this
                                    # environment when entering this directory

Starting the server

This fork is still an infant and I don't recommend using your own database with it.

1. You should first go to the project root and activate your python environment
2. Next create a config file that uses a data directory other than your personal lute data directory, or execute the following script to create a config which creates a data folder in the project directory

$ bash create_config.sh

3. Install needed python packages with pip

$ pip install -r requirements.txt

4. Start the server

$ python -m lute.main --port 5050   # If no port is provided, port 5000 will be used by default

License

Lute uses the MIT license: LICENSE