NLQ

Conversational data analysis tool.

Installation and Setup

Install the packages:

pip install -r requirements.txt

Updating Packages

If packages are added or require updates, be sure to run the following to capture the package state:

pip freeze > requirements.txt

Make sure the above is ran in a env environment. To make one, run the following:

python -m venv env

When you need to activate the environment, run:

source env/bin/activate

Setup

From home directory, allow the BASH script as an executable:

chmod +x runner.sh

Following the .env.example file, create a local .env file that has those credentials in the same directory.

Seeding Data

There are useful data generators available if needed across various domains. To configure your generator, modify setup.py.

Then, run the following:

./runner.sh seed 

More generators can be created using Faker inside db/generators.

Run App:

To run the app (after following 'Setup'), simply run:

./runner.sh

Format Code:

Prior to commiting, run the formatter:

./runner.sh format