Metadata-Version: 2.1
Name: wacy
Version: 0.0.4
Summary: Powering spaCy with Wave
Home-page: https://github.com/thewaverguy/wacy
Author: TheWaverGuy
Author-email: thewaverguy@gmail.com
License: Apache License, Version 2.0
Project-URL: Documentation, https://wacy.readthedocs.io
Project-URL: Source, https://github.com/thewaverguy/wacy
Project-URL: Tracker, https://github.com/thewaverguy/wacy/issues
Keywords: app,h2o_wave,nlp,spacy
Platform: any
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: h2o-wave (>=0.13.0)
Requires-Dist: spacy (>=3.0.0)

<div align='center'>

<img src="docs/source/_static/logo/logo_horizontal_light_450_x_150.svg">

Powering spaCy with Wave

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/wacy?color=orange&logo=python)](https://pypi.org/project/wacy)
[![PyPI Status](https://img.shields.io/pypi/v/wacy?label=pypi&color=green&logo=pypi)](https://pypi.org/project/wacy)
[![PyPI Status](https://pepy.tech/badge/wacy?rightcolor=yellowgreen)](https://pepy.tech/project/wacy)
[![ReadTheDocs](https://readthedocs.org/projects/wacy/badge/?version=stable)](https://wacy.readthedocs.io/en/stable)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/thewaverguy/wacy/blob/master/LICENSE)

Building blocks for interactive and customizable [spaCy](http://spacy.io)-powered apps with [Wave](https://h2oai.github.io/wave)

---

[Installation](#Installation) • [Setup](#Setup) • [Usage](#Usage) • [Documentation](#Documentation) • [License](#License) • [Credits](#Credits)

---

</div>

## 🚀 Installation

**Python 3.7 or higher is required**

To install stable version from [PyPI](https://pypi.org/project/wacy) (recommended):

```bash
pip install wacy
```

To install development version:

```bash
$ git clone https://github.com/thewaverguy/wacy
$ cd wacy
$ python3 -m pip install -r requirements.txt
```

## 💻 Setup

#### Wave

Download and run the [Wave server](https://github.com/h2oai/wave/releases) (latest version recommended):

On **Linux**:

```bash
wget https://github.com/h2oai/wave/releases/download/v0.13.0/wave-0.13.0-linux-amd64.tar.gz
tar -xvzf wave-0.13.0-linux-amd64.tar.gz
cd wave-0.13.0-linux-amd64
./waved
```

On **Mac**:

```bash
wget https://github.com/h2oai/wave/releases/download/v0.13.0/wave-0.13.0-darwin-amd64.tar.gz
tar -xvzf wave-0.13.0-darwin-amd64.tar.gz
cd wave-0.13.0-darwin-amd64
./waved
```

You should see the Wave server running:

```bash
#
# ┌─────────────────────────┐
# │  ┌    ┌ ┌──┐ ┌  ┌ ┌──┐  │ H2O Wave
# │  │ ┌──┘ │──│ │  │ └┐    │ 0.13.0 20210306054523
# │  └─┘    ┘  ┘ └──┘  └─┘  │ © 2021 H2O.ai, Inc.
# └─────────────────────────┘
#
```

#### spaCy

Download [spaCy models](https://spacy.io/usage/models)

```bash
venv/bin/python -m spacy download en_core_web_sm
venv/bin/python -m spacy download en_core_web_md
...
```

The above two models are required to run the sample base app.

You can also download more / other models and configure the app accordingly.

## ⌨️ Usage
Create a file for the Wave app:

```python
# wave_app.py
from h2o_wave import Q, main, app
from wacy.apps import BaseApp

wacy_app = BaseApp()

@app('/wacy')
async def serve(q: Q):
    await wacy_app.serve(q)
```

Run the app: `venv/bin/wave run wave_app.py`

The app will be available on [http://localhost:10101/wacy](http://localhost:10101/wacy)

## 📖 Documentation

Documentation: [https://wacy.readthedocs.io](https://wacy.readthedocs.io)   
Examples: [https://wacy.readthedocs.io/en/latest/examples.html](https://wacy.readthedocs.io/en/latest/examples.html)

## 📋 License

This project is licensed under the [Apache License 2.0](LICENSE)

## 🙏 Credits

spaCy: [https://spacy.io/](https://h2oai.github.io/wave)   
Wave: [https://h2oai.github.io/wave/](https://h2oai.github.io/wave)


