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 1520f08b05
Fix pre-commit hook + linting jobs for OAPEN engine (#14) 
* sync upstream

* isort, black, flake8 precommit hook

* Ignore bin

* reset bin

* reset bin

* try to fix black

* remove bin!

* update gh action
 		2022-10-23 19:51:47 -04:00
..
bin Create mining engine boilerplate (#2) 2022-09-27 15:07:50 -04:00
src OAP 26 (#12) 2022-10-18 11:31:49 -04:00
.gitignore Fix pre-commit hook + linting jobs for OAPEN engine (#14) 2022-10-23 19:51:47 -04:00
Pipfile OAP-15, OAP-22: Data ingest + text preprocessing (#6) 2022-10-04 08:22:55 -04:00
Pipfile.lock OAP-15, OAP-22: Data ingest + text preprocessing (#6) 2022-10-04 08:22:55 -04:00
README.md OAP-14: DB connection and seeding (#8) 2022-10-11 14:08:35 -04: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