Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freshollie/herobrain
A quiz prediction robot, designed for hqhero
https://github.com/freshollie/herobrain
Last synced: 3 days ago
JSON representation
A quiz prediction robot, designed for hqhero
- Host: GitHub
- URL: https://github.com/freshollie/herobrain
- Owner: freshollie
- License: mit
- Created: 2018-07-25T18:52:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-07T21:08:59.000Z (over 6 years ago)
- Last Synced: 2024-11-11T19:43:11.119Z (2 months ago)
- Language: Python
- Homepage:
- Size: 102 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Herobrain
Herobrain is a quiz prediction processor based on [HackQ-Trivia](https://github.com/Exaphis/HackQ-Trivia).
Herobrain was designed for use with [hqhero](https://github.com/freshollie/hqhero), and answers questions from HQTrivia.
## Running
Herobrain uses `pipenv` for dependency management.
1. `pipenv install --dev` will install all the required packages to ba able to run Herobrain
1. `pipenv run nltk-install` to install the language resources
1. `pipenv run python run.py` to run the processor
```
usage: run.py [-h] [-t TOKEN] [-s OUTPUT] [-l {en-uk,en-us,de}] [--test]
[--quiz-api QUIZ_API] [--test-api TEST_API]
[--log-level {critical,error,warning,info,debug}]
Herobrain, a quiz prediction processor
optional arguments:
-h, --help show this help message and exit
-t TOKEN, --token TOKEN
HQTrivia bearer token
-s OUTPUT, --output OUTPUT
HQhero server
-l {en-uk,en-us,de}, --locale {en-uk,en-us,de}
Configures methods of question analysis
--test Run in test mode, doesn't require bearer token
--quiz-api QUIZ_API HQTrivia quiz-api
--test-api TEST_API Simulated quiz-api, requires --test
--log-level {critical,error,warning,info,debug}
```
### Simulating questions
In order to simulate questions for herobrain, [trivia-sim](https://github.com/freshollie/trivia-sim)
can be used to create a simulated hqtriva API. Use `--test-api` to point herobrain to trivia-sim.
Please see trivia-sim documentation for further information.
## Languages
Herobrain is designed for English and German. However the German processing is not amazing.
## Production
herobrain is designed for use with docker. An example service config
```yml
services:
herobrain-uk:
image: "freshollie/herobrain:master"
networks:
- hqhero-net
command:
- --token
- TOKEN
- --hqhero
- http://hqhero-uk:1029/
- --log-level
- debug
networks:
hqhero-net:
```
## Auto-deployment
`bitbucket-piplines` were used to automatically build and deploy the herobrain image to hqhero.com.
this file can be edited for your bitbucket repository.
## Contributing
Any contribution to herobrain is welcome. Please submit pull requests with new features. Please make
an issue with any bugs or feature requests.
## License
herobrain is released under the `MIT` license. Please see file attribution where applicable.
## Credits
A very special thank you to [Kevin Wu](https://github.com/Exaphis) for the original
sourcecode that herobrain is based off.