Metadata-Version: 2.1
Name: buzzword
Version: 1.2.3
Summary: Web-app for corpus linguistics
Home-page: UNKNOWN
Author: Danny McDonald
Author-email: daniel.mcdonald@uzh.ch
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: buzz (>=3.0.6)
Requires-Dist: python-dotenv (==0.10.3)
Requires-Dist: flask (==1.1.1)
Requires-Dist: dash (==1.1.1)
Requires-Dist: dash-core-components (==1.1.1)
Requires-Dist: dash-html-components (==1.0.0)
Requires-Dist: dash-renderer (==1.0.0)
Requires-Dist: dash-table (==4.1.0)
Requires-Dist: dash-daq (==0.1.7)

# buzzword

> Version 1.2.3

[![Build Status](https://travis-ci.org/interrogator/buzzword.svg?branch=master)](https://travis-ci.org/interrogator/buzzword)
[![readthedocs](https://readthedocs.org/projects/buzzword/badge/?version=latest)](https://buzzword.readthedocs.io/en/latest/)
[![codecov.io](https://codecov.io/gh/interrogator/buzzword/branch/master/graph/badge.svg)](https://codecov.io/gh/interrogator/buzzword)
[![PyPI version](https://badge.fury.io/py/buzzword.svg)](https://badge.fury.io/py/buzzword)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)

> Web-app for corpus linguistics; documentation available [via ReadTheDocs](https://buzzword.readthedocs.io/en/latest/)

## Install

```bash
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.

```bash
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](https://buzzword.readthedocs.io/en/latest/building/)
1. [Configure a `.env` file](https://buzzword.readthedocs.io/en/latest/run/) from `.env.example`
2. [Configure a `corpora.json`](https://buzzword.readthedocs.io/en/latest/run/) file from `corpora.json.example`
3. Run the tool with or without [command line arguments](https://buzzword.readthedocs.io/en/latest/run/):

```bash
buzzword --debug
# or python -m buzzword --debug
```

