EbookFoundation
/
oapen-suggestion-service
mirror of https://github.com/EbookFoundation/oapen-suggestion-service.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
oapen-suggestion-service/oapen-engine
History
Celina Peralta 6d256249db Move daemon env vars to docker-compose.yml 2023-02-23 16:04:43 -05:00
..
src Move daemon env vars to docker-compose.yml 2023-02-23 16:04:43 -05:00
.gitignore Fix makefile for linux and variable python (#27) 2022-12-04 21:54:40 -05:00
Dockerfile OAP-53 Fix engine Dockerfile, build psycopg2 from source not binary, write daemon (#32) 2023-02-10 07:45:44 -05:00
Makefile Setup docker (#26) 2022-12-13 07:46:08 -05:00
Pipfile OAP-53 Fix engine Dockerfile, build psycopg2 from source not binary, write daemon (#32) 2023-02-10 07:45:44 -05:00
README.md OAP-37: Read stopwords from txt (#23) 2022-11-16 17:22:34 -05:00
pipenv-proper-names.txt Create mining engine boilerplate (#2) 2022-09-27 15:07:50 -04:00
pyvenv.cfg OAP-22: Set up python build job in GH actions (#4) 2022-09-30 15:49:04 -04:00

README.md

OAPEN Suggestion Service

Getting Started

Database Configuration (Local)

Create a database.ini file in oapen-engine/src with the following:

[postgresql]
host=localhost
database=postgres
user=<username>
password=<your-password>

Environment setup

cd oapen-engine
make setup-env

Seeding the database

make clean_db
make seed_db

Running ngrams

make run

How to deactivate virtual environment

While the virtual environment is running, type:

deactivate

How to remove/filter out bad ngrams

Members of EbookFoundation can create a pull request to edit the stopwords used to filter out bad trigrams:

oapen-engine/src/model/stopwords_*.txt

This also can be done to remove a malformed trigram already in the database (during the next run)