This package - code and documentation - is still under construction.

Karp is the lexical platform of Språkbanken.

Karp in Docker

For easy testing, use Docker to run Karp-b.

• Follow the steps given here

• Run docker-compose up -d

• Test it by running curl localhost:8081/app/test

If you want to use Karp without Docker, keep on reading. Prerequisites

• ElasticSearch2
• SQL, preferrably MariaDB
• a WSGI server for example mod_wsgi with Apache, Waitress, Gunicorn, uWSGI. . . http://modwsgi.readthedocs.io/en/develop/ http://httpd.apache.org/
• an authentication server. Read more about this here
• Python >= 2.7 with pip

Installation

Karp uses virtuals envs for python. To get running:

1. Install virtualenv using pip install virtualenv
2. Create the virtual environment using virtualenv venv.
3. Activate the virtual environment with source venv/bin/activate.
4. pip install -r requirements.txt

Configuration

Copy config.json.example to config.json and make your changes. You will also need to make configurations for your lexicons. Read more [here](TODO manual.md).

Tests

TODO: DO MORE TESTS! Test that Karp-b is working by starting it python src/main.py