buzzword 1.4.0

Web-app for corpus linguistics

buzzword

Version 1.4.0

Web-app for corpus linguistics; documentation available via ReadTheDocs

Note, this app is currently being overhauled and turned into a Django project. The last stable (Dash) app was version 1.2.5. Versions after this will be in Django, and for now, a bit unstable, as features like user management are added in. Documentation for now targets 1.2.5, not the new Django app.

Install

pip install buzzword

Quickstart

The buzzword.create command will create a directory and populate it with the necessary config files and a sample corpus. Here, we name it workspace and run buzzword from within it.

buzzword-create workspace
# or: python -m buzzword.create workspace
cd workspace
python -m buzzword

Setup

To set things up more more permanently, either modify the directory created with buzzword-create, or do the following:

0. Create and parse corpus
1. Configure a .env file from .env.example
2. Configure a corpora.json file from corpora.json.example
3. Run the tool with or without command line arguments:

buzzword --debug
# or python -m buzzword --debug

Run from Dockerfile

docker build . -t name/tag
docker run -it -p 8001:8000 name/tag

buzzword is now available at http://localhost:8001