Metadata-Version: 2.1
Name: qary
Version: 0.6.26
Summary: A chatbot that assists rather than manipulates.
Home-page: https://github.com/qary/qary
License: MIT
Author: ProAI
Author-email: hobson@proai.org
Requires-Python: >=3.6.3,<3.9
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: ConfigArgParse (==1.2.2)
Requires-Dist: Sphinx (==3.0.3)
Requires-Dist: beautifulsoup4 (>=4.9.3,<5.0.0)
Requires-Dist: boto3 (==1.13.19)
Requires-Dist: botocore (==1.16.19)
Requires-Dist: django (==3.0.7)
Requires-Dist: docutils (==0.15.2)
Requires-Dist: edit-distance (==1.0.4)
Requires-Dist: elasticsearch (>=7.6.0,<8.0.0)
Requires-Dist: environment (==1.0.0)
Requires-Dist: gitpython (==3.1.1)
Requires-Dist: html5lib (==1.1)
Requires-Dist: importlib_metadata (>=1.6.0,<2.0.0); python_version < "3.8"
Requires-Dist: jedi (>=0.18.0,<0.19.0)
Requires-Dist: jupyter (==1.0.0)
Requires-Dist: lxml (==4.5.0)
Requires-Dist: m2r (==0.2.1)
Requires-Dist: nltk (==3.5)
Requires-Dist: pandas (==1.0.3)
Requires-Dist: pronouncing (==0.2.0)
Requires-Dist: psutil (==5.8.0)
Requires-Dist: pytest (==6.2.2)
Requires-Dist: pytest-cov (==2.11.1)
Requires-Dist: python-dotenv (>=0.13.0,<0.14.0)
Requires-Dist: python-slugify (==4.0.0)
Requires-Dist: rapidfuzz (==0.9.1)
Requires-Dist: recommonmark (==0.6.0)
Requires-Dist: regex (==2020.4.4)
Requires-Dist: rich (>=9.8.2,<10.0.0)
Requires-Dist: scikit-image (>=0.17.2,<0.18.0)
Requires-Dist: scikit-learn (==0.22.2)
Requires-Dist: scipy (==1.4.1)
Requires-Dist: seaborn (==0.10.0)
Requires-Dist: spacy (>=3.0.0,<3.1.0)
Requires-Dist: torch (>=1.8.0,<1.9.0)
Requires-Dist: tox (>=3.23.0,<4.0.0)
Requires-Dist: tqdm (>=4.38.0,<4.39.0)
Requires-Dist: transformers (>=4.3.0,<4.4.0)
Requires-Dist: typer[all] (>=0.3.2,<0.4.0)
Requires-Dist: wikipedia-api (==0.5.4)
Requires-Dist: yake (==0.4.6)
Requires-Dist: yaml (==5.4.1)
Project-URL: Repository, https://github.com/qary/qary
Description-Content-Type: text/markdown

[![Buy Us Tea](https://github.com/nlpia/nlpia-bot/raw/develop/docs/media/small-leaf-and-name-screenshot-31x80.png)](https://buymeacoffee.com/hobs)
[![PyPI version](https://img.shields.io/pypi/pyversions/qary.svg)](https://pypi.org/project/qary/)
[![License](https://img.shields.io/pypi/l/qary.svg)](https://pypi.python.org/pypi/qary/)
[![codecov](https://codecov.io/gl/tangibleai/qary/branch/master/graph/badge.svg)](https://codecov.io/gl/tangibleai/qary)

# `qary`

The `qary` package is both a chatbot framework and a working "reference implementation" virtual assistant that actually assists! Most bots manipulate you to make money for their corporate masters. With qary, you can build **your** bot to protect you and amplify your intelligence and prosocial instincts.

`qary` was conceived as part of [NLP in Action](https://www.manning.com/books/natural-language-processing-in-action) book, is maintained by an [active developer community](/docs/wiki/contributors.md) and is supported by [San Diego Python User Group](https://www.pythonsd.org/index.html) (some qary talks [here](https://www.youtube.com/playlist?list=PLOa5qP-zwt22Noym1Nf8BeL24NeE__ofj) and in `docs/`) and [San Diego Machine Learning Group](https://www.meetup.com/San-Diego-Machine-Learning/).


## Install

### Package install
`qary` package can be installed from [PyPi](https://pypi.org/project/qary/) by running:

```bash
pip install qary
```

### Developer install

First retrieve a copy of the source code for `qary`:

```bash
git clone git@gitlab.com:tangibleai/qary
cd qary
```

Then, install and use the `conda` python package manager within the [Anaconda](https://www.anaconda.com/products/individual#Downloads) software package.

```bash
conda update -y -n base -c defaults conda
conda create -y -n qaryenv 'python>=3.6.5,<3.9'
conda env update -n qaryenv -f environment.yml
conda activate qaryenv || source activate qaryenv
pip install --editable .
```

**Windows Users**: [docs/README-windows-install.md](docs/README-windows-install.md)

## Usage

```bash
$ qary --help
usage: qary [-h] [--version] [--name STR] [-p] [-s STR] [-v] [-vv] [words [words ...]]
```

### Running `qary` for just one skill

```bash
$ qary -s qa
# ... (logging messages)
YOU: When was Barack Obama born?
# ... (logging messages)
qary: August 4, 1961
```

### `qary` skills

`qary`'s probabilistic conversation manager chooses a reply from the possiblities generated by the different personalities:

- `pattern` (`skills/pattern.py`): example skill using regex patterns to reply to greetings like "hi"
- `qa` (`skills/qa.py`): BERT and ALBERT Wikipedia Question Answering (WikiQA reading comprehension tests)
- `faq` (`skills/faq.py`): answers to frequently asked questions using data/faq/*.yml
- `glossary` (`skills/glossary.py`): definitions from glossary yml files in data/faq/glossary-*.yml
- `eliza` (`eliza.py`): a python port of the ELIZA therapist bot

### Configuring default personalities

By default, `qary` runs with `qa` personality. Check out the config file in `qary.ini` to change the default skills loaded for your own custom skill in the skills directory.

## Approach

`qary`'s chatbot framework allows you to combine many approaches to give you state-of-the-art capability to answer questions and carry on a conversation:

1. search: [chatterbot](https://github.com/gunthercox/ChatterBot), [will](https://github.com/skoczen/will)
2. pattern matching and response templates: Alexa, [AIML](https://github.com/keiffster/program-y)
3. generative deep learning: [robot-bernie](https://github.com/nlpia/robot-bernie), [movie-bot](https://github.com/totalgood/nlpia/blob/master/src/nlpia/book/examples/ch10_movie_dialog_chatbot.py)
4. grounding: [snips](https://github.com/snipsco/snips-nlu)

It's all explained in detail at [NLP in Action](https://www.manning.com/books/natural-language-processing-in-action).

Presentations for San Diego Python User Group are in [docs/](/docs/2019-08-22--San Diego Python User Group -- How to Build a Chatbot.odp) and on the web at [http://totalgood.org/midata/talks](http://totalgood.org/midata/talks/)

## Contributing pattern for developers

DM @hobs if you'd like to join us for weekly Zoom collaborative-coding sessions.

1. [Create a fork](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html#creating-a-fork) of the [main qary repository](https://gitlab.com/tangibleai/qary) on Gitlab.
2. Make your changes in a branch named something different from `master`, e.g. create
   a new branch `my-pull-request`.
3. [Create a merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html).
4. Help your fellow contributors out by:
  - Follow the [PEP-8 style guide](https://www.python.org/dev/peps/pep-0008/).
  - Try to include a docstring, at least a single line, in any function, method, or class
  - Bonus points for adding a [doctest](https://docs.python.org/3/library/doctest.html) as part of your contribution.
  - If you add a new feature, write some quick docs in the README.
  - Add your name and attribution to the AUTHORS file.
  - Know we are grateful for your contribution! You've made the chatbot world a little better!


