Metadata-Version: 2.1
Name: buzzword
Version: 1.4.0
Summary: Web-app for corpus linguistics
Home-page: UNKNOWN
Author: Danny McDonald
Author-email: daniel.mcdonald@uzh.ch
License: MIT
Description: # buzzword
        
        > Version 1.4.0
        
        [![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/)
        
        > 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
        
        ```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
        ```
        
        ## Run from Dockerfile
        
        ```bash
        docker build . -t name/tag
        docker run -it -p 8001:8000 name/tag
        ```
        buzzword is now available at http://localhost:8001
Keywords: nlp,linguistics,corpora
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
