jarvis-core

Wit.ai powered chatbot

These details have not been verified by PyPI

Project links

Homepage

GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Project description

# Jarvis

Natural Language UI for custom APIs using wit.ai

## 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.

### Prerequisites

Register and create a chatbot in [wit.ai](https://wit.ai) and obtain and api key for your bot.
Install Python and recommended install virtualenv for the project.

### Installing

Installing the jarvis dependencies

` pip install -r requirements.txt `

For Jarvis to interact with your wit bot

## Running

Set the WIT environment variable to your previously retrieved server access token from wit.ai

` WIT=YOUR_SERVER_ACCESS_TOKEN python jarvis.py `

End with an example of getting some data out of the system or using it for a little demo

## Running the tests

Explain how to run the automated tests for this system

### Break down into end to end tests

Explain what these tests test and why

` Give an example `

### And coding style tests

Explain what these tests test and why

` Give an example `

## Deployment

Add additional notes about how to deploy this on a live system

## Built With

[Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
[Maven](https://maven.apache.org/) - Dependency Management
[ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds

## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) 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