Skip to content

DevEnvironmentSetup

Alex Rudnick edited this page Oct 13, 2013 · 5 revisions

You'll need:

  • Python 3.3+ (so you may want Ubuntu 13.04 or later, if you're into Ubuntu)
  • virtualenv (package python-virtualenv on Ubuntu)

Once you have that set up, and you have the source checked out, go to your guampa checkout and go:

$ scripts/setup_virtualenv.sh

That should create a virtualenv for you with the appropriate dependencies: Flask, sqlalchemy, and Beautiful Soup, and NLTK so far. Then you need to activate that virtualenv:

$ . venv/bin/activate

If you're using a shell other than bash, there should be an appropriate script in venv/bin for you.

To run the dev server, go:

$ scripts/devserver.sh

You might note that there aren't any documents in the database! You can add one, and put a tag on it, like so:

$ scripts/store_document.sh documents/sample.txt
$ scripts/tag_document.sh 1 "this is a tag"