Ravestate is a reactive library for real-time natural language dialog systems.
Project description
_ __ _ __
_ ___ ____ __ ______ ______/ /_____/ /___
_ _ / \/ __ \/ / / / __ \/ ___\, / __ \, /__ \
_ _ / /\/ /_/ /\ \/ / /_/ /\__, / / /_/ / / /_/ /
_ \/ _\__/\/ _\__/ ,___/\____/\/\__/\/\/ ,___/
_____ _ _\____/ _ _\____/
/_ _\
0> 0>
\__⊽__/ (C) Roboy 2019
⋂
About
Ravestate is a reactive library for real-time natural language dialog systems.
Installation
Via PIP
The easiest way to install ravestate is through pip:
pip install ravestate
For developers
First, install dependencies:
pip install -r requirements.txt
# To run tests, install pytest, mocking, fixtures...
pip install -r requirements-dev.txt
Then, you may open the repository in any IDE, and mark the
modules
folder as a sources root.
Running Hello World
Ravestate applications are defined by a configuration, which specifies the ravestate modules that should be loaded.
To run the basic hello world application, run ravestate with a config file or command line arguments:
Running with command line spec
You can easily run a combination of ravestate modules in a shared context,
by listing them as arguments to the rasta
command, which is installed
with ravestate:
rasta ravestate_conio ravestate_hello_world
Run rasta -h
to see more options!
Running with config file(s)
You may specify a series of config files to configure ravestate context, when specifying everything through the command line becomes too laborious:
# In file hello_world.yml
module: core
config:
import:
- ravestate_conio
- ravestate_hello_world
Then, run rasta
with this config file:
rasta -f hello_world.yml
Running tests
If you have installed the dependencies from requirements-dev.txt
you
may run the ravestate test suite as follows:
./run_tests.sh
Building/maintaining the docs
If you have installed the dependencies from requirements-dev.txt
,
generate the docs by running this command at project root:
export PYTHONPATH=$PYTHONPATH:$(pwd)/modules
git rm -rf docs
rm -rf _build docs
pydocmd build
git add docs/*
The structure and content of the docs are defined in the file pydocmd.yml
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ravestate-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7de3078679cc90df42bc09f94478201ea3f49e6fb49d16a837ff859f26374e0d |
|
MD5 | f23b1cb3d307410ad371d8127918fae5 |
|
BLAKE2b-256 | dd4b68c2c9a28a68b745fbafe48925cdc4357df5c16eb5f4890ddbedb3ef028f |