Eigen_Tech_NLP_Project

NLP project which leverages a.o. NLTK and Sklearn to create an (in memory) inverted index for a collection of .txt files containing textual data.

Installation:

There are two options here: installation from source and installation with pip.

1. Installation from source:

Clone the public repository:

$ git clone git://github.com/jgeysen/eigen_tech_project

cd into the repository:

$ cd eigen_tech_project

and run the following:

$ python setup.py install

2. Installation with pip:

$ pip install -e git+ssh://[email protected]/jgeysen/eigen_tech_project.git@main#egg=eigen_tech_project

Setup for development (with pipenv):

Clone the public repository:

$ git clone git://github.com/jgeysen/eigen_tech_project

cd into the repository:

$ cd eigen_tech_project

and run the following:

# Install dependencies
$ pipenv install --dev

# Setup pre-commit and pre-push hooks
$ pipenv run init

To activate the environment, again from the root directory of the repo:

pipenv shell

To create and view the documentation:

pipenv run make_docs