Skip to main content

An engine for chatbots. Inspired by Watson Assistant and Rasa.

Project description

Dazu

Documentation Status BUILD Open Source Helpers Maintainability Test Coverage

Dazu is a powerfull engine dialogue engine with two main parts: NLU and dialogue. The main objetive of this project is too use existing chatbots projects and uses it to develop your solution.

The name was inspired by Dazu Ausubel because the main objective of this project was to build a collaborative platform to maintain Bots for learning.

Inspired by Watson Assistant and Rasa.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

  • Docker:
docker-compose up --build
  • Editable mode:
pip install -e .
cd examples/my-first-bot
dazu train
dazu run
  • After that you should see this output:
dazu run
 * Serving Flask app "dazu.__main__" (lazy loading)
 * Environment: production
   WARNING: Do not use the development server in a production environment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)

Prerequisites

  • To build, first install all necessary dependencies:

All the dependencies can be find in requirements.txt and development in requirements-dev.txt.

Installing Development Environment

  • A step by step installation guide:
  1. Run these commands to install dazu in your python virtual env:
pip install -r requirements-dev.txt
pip install -e .
  1. Go to examples folder and start the project:
cd examples/my-first-bot
dazu train
dazu run
  1. Have fun :rocket:

Code Style

To ensure a standardized code style we use the formatter black. To ensure our type annotations are correct we use the type checker pytype. If your code is not formatted properly or doesn't type check, travis will fail to build.

Formatting

If you want to automatically format your code on every commit, you can use pre-commit. Just install it via pip install pre-commit and execute pre-commit install in the root folder. This will add a hook to the repository, which reformats files on every commit.

If you want to set it up manually, install black via pip install -r requirements-dev.txt. To reformat files execute

make formatter

Type Checking

If you want to check types on the codebase, install pytype using pip install -r requirements-dev.txt. To check the types execute

make types

Running the tests

Still needed

Deployment

Still needed

Built With

  • Python - The main programing language used

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Raphael Pinto - Creator - ralphg6

See also the list of contributors who participated in this project.

License

This project is licensed under the Apache-2.0 - see the LICENSE file for details

Acknowledgments

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dazu-0.1.0.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

dazu-0.1.0-py3-none-any.whl (32.6 kB view details)

Uploaded Python 3

File details

Details for the file dazu-0.1.0.tar.gz.

File metadata

  • Download URL: dazu-0.1.0.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.10

File hashes

Hashes for dazu-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c192bfb4533c66ac78eba9090fcd964fb0d202324a87474d4e9faa2485f92c5e
MD5 a8af1e377eb50583eca3705621c8f0f7
BLAKE2b-256 f1c7a212a19f8d0749d9af7281d088a9a31c63560ca9191e86a955cb3734d58d

See more details on using hashes here.

File details

Details for the file dazu-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: dazu-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 32.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.10

File hashes

Hashes for dazu-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 af247c2e276ad461ba5d857ec5224afa4f685083c2e22ff4f51847f09c7ba2a4
MD5 e4e9d1ebe5a97fe663d893a4429060bd
BLAKE2b-256 6d2b8713146d6920c9638e02faa499c52119c49bce785f709cfd90fb61da7769

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page