Metadata-Version: 2.1
Name: dazu
Version: 0.1.0
Summary: An engine for chatbots. Inspired by Watson Assistant and Rasa.
Home-page: https://github.com/ralphg6/dazu
Author: Raphael Pinto
Author-email: raphaelcpinto@gmail.com
Maintainer: Raphael Pinto
Maintainer-email: raphaelcpinto@gmail.com
License: Apache 2.0
Download-URL: https://github.com/ralphg6/dazu/archive/0.1.0.tar.gz
Project-URL: Bug Reports, https://github.com/ralphg6/dazu/issues
Project-URL: Source, https://github.com/ralphg6/dazu
Description: # Dazu
        
        [![Documentation Status](https://readthedocs.org/projects/dazu-ausubel/badge/?version=latest)](https://dazu-ausubel.readthedocs.io/en/latest/?badge=latest)
        ![BUILD](https://github.com/ralphg6/dazu/workflows/Python%20application/badge.svg?branch=master)
        [![Open Source Helpers](https://www.codetriage.com/ralphg6/dazu/badges/users.svg)](https://www.codetriage.com/ralphg6/dazu)
        [![Maintainability](https://api.codeclimate.com/v1/badges/2eb8ba0d056e3b52f34a/maintainability)](https://codeclimate.com/github/ralphg6/dazu/maintainability)
        [![Test Coverage](https://api.codeclimate.com/v1/badges/2eb8ba0d056e3b52f34a/test_coverage)](https://codeclimate.com/github/ralphg6/dazu/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](https://novaescola.org.br/conteudo/262/dazu-ausubel-e-a-aprendizagem-significativa) 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:
        
        ```bash
        docker-compose up --build
        ```
        
        * Editable mode:
        
        ```bash
        pip install -e .
        cd examples/my-first-bot
        dazu train
        dazu run
        ```
        
        * After that you should see this output:
        
        ```bash
        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:
        
        ```bash
        pip install -r requirements-dev.txt
        pip install -e .
        ```
        
        1. Go to examples folder and start the project:
        
        ```bash
        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](https://github.com/ambv/black).
        To ensure our type annotations are correct we use the type checker [pytype](https://github.com/google/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](https://pre-commit.com/).
        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
        ```bash
        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
        ```bash
        make types
        ```
        
        ## Running the tests
        
        `Still needed`
        
        ## Deployment
        
        `Still needed`
        
        ## Built With
        
        * [Python](https://www.python.org/) - The main programing language used
        
        ## Contributing
        
        Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
        
        ## Versioning
        
        We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 
        
        ## Authors
        
        * **Raphael Pinto** - *Creator* - [ralphg6](https://github.com/ralphg6)
        
        See also the list of [contributors](https://github.com/ralphg6/dazu/graphs/contributors) who participated in this project.
        
        ## License
        
        This project is licensed under the Apache-2.0 - see the [LICENSE](LICENSE) file for details
        
        ## Acknowledgments
        
        * **Arthur Temporim** - [arthurTemporim](https://github.com/arthurTemporim)
        
        
Keywords: nlp machine-learning machine-learning-library bot bots botkit rasa conversational-agents conversational-ai chatbotchatbot-framework bot-framework watson nlu
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.6
Description-Content-Type: text/markdown
