Merge pull request #32 from Roboy/whiskey-rebellion

Ravestate v0.3.0

.gitignore

@@ -8,7 +8,10 @@ tts.wav
 keys.yml
 dist/*
 build/*
+_build/*
+*.log
 *.egg-info
 ros2/build
 ros2/install
 ros2/log
+mkdocs.yml

.travis.yml

@@ -0,0 +1,22 @@
+sudo: required
+language: python
+os: linux
+python:
+  - "3.6"
+# Enable 3.7 without globally enabling sudo and dist: xenial for other build jobs
+matrix:
+  include:
+    - python: 3.7
+      dist: xenial
+      sudo: true
+before_install:
+  - sudo apt-get install -y portaudio19-dev
+# command to install dependencies
+install:
+  - pip install -r requirements.txt -r requirements-dev.txt -q
+# command to run tests
+script:
+  - ./run_tests.sh
+
+after_success:
+  - codecov

LICENSE

@@ -1,21 +1,29 @@
-MIT License
+BSD 3-Clause License
 
-Copyright (c) 2018 Roboy
+Copyright (c) 2018, Roboy
+All rights reserved.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,13 +1,13 @@
 ```
                                  _ __    _ __     
     _ ___ ____  __  ______  ______/ /_____/ /___     
- _ _ /  \/ __ \/ / / /__  \/ ___\, / __ \, /__  \  
+ _ _ /  \/ __ \/ / / / __ \/ ___\, / __ \, /__  \  
 _ _ / /\/ /_/ /\ \/ / /_/ /\__, / / /_/ / / /_/ /     
   _ \/ _\__/\/ _\__/ ,___/\____/\/\__/\/\/ ,___/
  _____          _ _\____/             _ _\____/                    
 /_   _\
  0>  0> 
-\__⊽__/  (C) Roboy 2018
+\__⊽__/  (C) Roboy 2019
    ⋂                                           
 ```
 
@@ -94,3 +94,16 @@ 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:
+
+```bash
+git rm -rf docs
+rm -rf _build docs
+pydocmd build
+```
+
+The structure and content of the docs are defined in the file ``pydocmd.yml``.

codecov.yml

@@ -0,0 +1,18 @@
+codecov:
+  notify:
+    require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+
+  status:
+    project: yes
+    patch: yes
+    changes: no
+
+comment:
+  layout: "reach, diff, flags, files, footer"
+  behavior: default
+  require_changes: no

config/generic.yml

@@ -0,0 +1,36 @@
+# In addition to this file, load a config file `keys.yml`, where
+#  `keys.yml` should contain the following content:
+#
+#   module: telegramio
+#   config:
+#     telegram-token: <sexycactus>  # Your telegram token here
+#   ---
+#   module: ontology
+#   config:
+#     neo4j_address: bolt://localhost:7687  # Your neo4j server uri here
+#     neo4j_username: neo4j                 # Your neo4j user here
+#     neo4j_pw: <cornycrab>                 # Your neo4j pw here
+#
+# Then, start `rasta` with `-f config/generic.yml -f config/keys.yml`
+
+---
+module: core
+config:
+  tickrate: 5
+  import:
+    - ravestate_interloc
+    - ravestate_conio
+    - ravestate_wildtalk
+    - ravestate_nlp
+    - ravestate_hibye
+
+---
+module: genqa
+config:
+  drqa_server_address: "http://localhost:5000"
+  roboy_answer_sanity: 1000
+
+---
+module: roboyqa
+config:
+  roboy_node_id: 356

config/roboy.yml

@@ -0,0 +1,38 @@
+# In addition to this file, load a config file `keys.yml`, where
+#  `keys.yml` should contain the following content:
+#
+#   module: telegramio
+#   config:
+#     telegram-token: <sexycactus>  # Your telegram token here
+#   ---
+#   module: ontology
+#   config:
+#     neo4j_address: bolt://localhost:7687  # Your neo4j server uri here
+#     neo4j_username: neo4j                 # Your neo4j user here
+#     neo4j_pw: <cornycrab>                 # Your neo4j pw here
+#
+# Then, start `rasta` with `-f config/generic.yml -f config/keys.yml`
+
+---
+module: core
+config:
+  tickrate: 10
+  import:
+    - ravestate_interloc
+    - ravestate_conio
+    - ravestate_wildtalk
+    - ravestate_nlp
+    - ravestate_hibye
+    - ravestate_roboyqa
+    - ravestate_genqa
+
+---
+module: genqa
+config:
+  drqa_server_address: "http://localhost:5000"
+  roboy_answer_sanity: 1000
+
+---
+module: roboyqa
+config:
+  roboy_node_id: 356

config/hello_world.yml → config/telegram_generic.yml

@@ -1,6 +1,8 @@
+---
 module: core
 config:
   import:
+    - ravestate_telegramio
     - ravestate_conio
     - ravestate_wildtalk
     - ravestate_nlp

deploy.sh

@@ -1,4 +1,11 @@
 #!/usr/bin/env bash
 
-python3 setup.py sdist bdist_wheel
+export setupfile=${1}
+
+if [[ ! $setupfile ]]; then
+    export setupfile=setup.py
+fi
+
+rm -rf dist
+python3 $setupfile sdist bdist_wheel
 twine upload dist/*