Raven¶
Raven is an umbrella package which is has intergation Raven-Bot(small NLU chatbot), TUI(simple Terminal User Interface) and Tx(Sanic web framework).
Warning
This project is still under hatching. So please support me till it hatches and spines of around the whole world, fast than speed of ‘SuperMan’.
To know more about raven follow the document
Contributing¶
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Stable release¶
This is the preferred method to install Tx, as it will always install the most recent stable release.
If you don’t have pip installed, this Python installation guide can guide you through the process.
From sources¶
The sources for Tx can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/jawahar273/Tx
Or download the tarball:
$ curl -OL https://github.com/jawahar273/Tx/tarball/master
Pipenv¶
Pipenv automatically create and manages the dependency using pip, virtualenv and adding/removing
the packages using Pipfile and Pipfile.lock. One of the main object is remove the
dependency on requirement.txt file.
pip install --user pipenv
The requirements/*.txt is compartable with Pipenv for recurrent installing of packages.
# step: 1 (for development/production)
pipenv install -r requirements/base.txt
# setp: 2 (for development only)
pipenv install -r requirements/local.txt --dev
# setp: 3 (only if you are need CLI)
pipenv install -r requirements/CLI.txt
# setp: 3 (only if you need Sanic)
pipenv install -r requirements/sanic.txt
To Get Starting¶
To get start with Raven-Bot might be difficult at first sight. Don’t worry here are
some instruction to get start with the bot. Step: 1 is installing the piece of the code.
Warning
Hey if you thought the below section is hard to read then read this section Usage.
Step: 2¶
Use of a CLI thing so called scaff.py which intensify generate scaffolding for us, which a half
way through. There are two major sub division to remember in working with Raven-Bot one
is storage is folder which contain of sub folder along with intents sets(intents set are collection of
intent and organized in such a way for human classification) and other folder is called
response which contain the code to executed if the engine choose the response to show.
Note
Please use –help before running the CLI to know what it is generating.
Step: 3 (optional)¶
Human do love to interaction with people but with bot(who cares??? ah…). Who knows you may love it but not at first site. Through training might need regressively.