How to develop

Prerequisites

The application uses python 3.6.1 and pip 9.x

You can use whatever IDE/Text editor you want, but PyCharm is recommended.

Setup

1. Clone the repository

git clone git@github.com:szyku/nltk-api.git

2. Enter the container and install dependencies from requirements.txt

cd nltk-api && pip install -r requirements.txt

3. Download the WordNet database using the nltk module

python -W ignore -m nltk.downloader wordnet

4. Run tests

nosetests

Branching & merging conduct

Branch from master branch and when you're done make a PR directly to master. You need an approval and a green build to have your branch accepted. That's it.