github prep

This commit is contained in:
Alex Orid 2021-05-13 16:33:27 -04:00
parent 18c4792b58
commit db0e63c933
8 changed files with 58 additions and 31 deletions

View File

@ -24,26 +24,35 @@ To Stop:
<br>
___
## Python Scripts:
### User TTS Speaker:
To receive audio from standalone_tt_core.py launch standalone_tts_speaker.py.
To receive audio from standalone_tt_core.py launch standalone_tts_speaker.py.
`python standalone_tts_speaker.py`
`python standalone_tts_speaker.py`
or
windows: `praxis-tts-speaker.bat`
or
windows: `praxis-tts-speaker.bat` Modify this to match the correct directory! Or no work for YOU!!!<br>
linux: `praxis-tts-speaker.sh`<br>
<br>
___
### User Web Client:
To access the User Client visit `index.html` from `\user_client\v1\` in your browser.<br>
<br>
___
# Credentials:
## Credentials Setup:
Create a json based on the templates and put them into the `/credentials/` folder.
Refer to the `/credential_templates/` folder for examples.
Refer to the `/credential_templates/` folder for examples.<br>
<br>
## For Twitch Credentials:
### Twitch IRC Chat Credentials:
Username = `TwitchUsername` *(Must match ***credentialsNickname*** in config)*
Helix Client ID = `https://dev.twitch.tv/console/apps`
@ -52,15 +61,34 @@ Oauth = `https://twitchapps.com/tmi/`
V5 Client ID = `https://twitchtokengenerator.com/`
## For Database Credentials:
Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)*
### Twitch PubSub Credentials:
Engine = `"mysql+mysqlconnector://root:password@localhost:3306/DatabaseName"`
pubsub_client_id = `https://dev.twitch.tv/console/apps` Set url to `http://localhost:17563`
pubsub_secret = `^Look at Instructions Above^`
pubsub_AccessToken = Generate by using: `python twitch_generate_credentials.py`
pubsub_RefreshToken = `^Look at Instructions Above^`<br>
<br>
## For Database Credentials:
Will be replaced soon.<br>The current `db.py` file is not being used for now.<br>
~~Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)*~~
~~Engine = `"mysql+mysqlconnector://root:password@localhost:3306/DatabaseName"`~~<br>
<br>
## For Discord Credentials:
Nickname = `Anything You Want` *(Must match ***credentialsNickname*** in config)*
Token = `https://discord.com/developers/`
Token = `https://discord.com/developers/`<br>
<br>
## Phue Credentials:
The lights module will only be able to establish and generate credentials if the button on the bridge is pressed prior to running the script via:
`python lights_module.py`<br>
After running a credential file will be created in the user's home directory on their operating system called `.python_hue` this can then be moved into the credentials folder.<br>
<br>
## Credential Usage:

View File

@ -142,6 +142,6 @@ PollyVoice = PollyVoices.Justin
#Misc Configs
slurList = badwords.slurList
praxisVersion_Alpha = "A.0 "
praxisVersion_Delta = "D.1 "
praxisVersion_Omega = "O.0 "
praxisVersion_Alpha = "0 " #Build
praxisVersion_Delta = "1 " #Minor
praxisVersion_Omega = "0.8 " #Major

View File

@ -1,7 +1,6 @@
from commands.command_base import AbstractCommand
from enum import Enum
import config as config
import db
import commands.loader as command_loader
@ -10,7 +9,6 @@ import credentials
class Help_Module():
def __init__(self):
super().__init__()
#self.dbCredential: credentials.DB_Credential
def main(self):
print("[Help Module]> help test")
@ -68,7 +66,4 @@ Help_Module_ = Help_Module()
if __name__ == "__main__":
testModule = Help_Module()
#credentials_manager = credentials.Credentials_Module()
#credentials_manager.load_credentials()
#testModule.dbCredential = credentials_manager.find_DB_Credential(config.credentialsNickname)
testModule.main()

11
makedockerimages.sh Normal file
View File

@ -0,0 +1,11 @@
#!/bin/bash
docker build --file Dockerfile_standalone_user_client.Dockerfile --tag standalone_user_client .
docker build --file Dockerfile_standalone_eventlog.Dockerfile --tag standalone_eventlog .
docker build --file Dockerfile_standalone_command.Dockerfile --tag standalone_command .
docker build --file Dockerfile_standalone_channelRewards.Dockerfile --tag standalone_channelrewards .
docker build --file Dockerfile_standalone_lights.Dockerfile --tag standalone_lights .
docker build --file Dockerfile_standalone_tts_core.Dockerfile --tag standalone_tts_core .
docker build --file Dockerfile_standalone_websource.Dockerfile --tag standalone_websource .
docker build --file Dockerfile_standalone_DiscordScript.Dockerfile --tag standalone_discordscript .
docker build --file Dockerfile_standalone_TwitchScript.Dockerfile --tag standalone_twitchscript .
docker build --file Dockerfile_standalone_Twitch_Pubsub.Dockerfile --tag standalone_twitch_pubsub .

2
praxis-tts-speaker.sh Normal file
View File

@ -0,0 +1,2 @@
#!/bin/bash
python "c:\praxis\standalone_tts_speaker.py"

View File

@ -1,12 +1,11 @@
import config as config
import db
import credentials
class Test_Module():
def __init__(self):
super().__init__()
self.dbCredential: credentials.DB_Credential
def main(self):
print("[TEST Module]> test")
@ -15,7 +14,4 @@ class Test_Module():
if __name__ == "__main__":
testModule = Test_Module()
credentials_manager = credentials.Credentials_Module()
credentials_manager.load_credentials()
testModule.dbCredential = credentials_manager.find_DB_Credential(config.credentialsNickname)
testModule.main()

View File

@ -286,7 +286,7 @@
<div class="col s12 center">
<h1>Made by Alex Orid,<br> The Curious Nerd</h1>
<h5>Need Help? Want to help out?<br><a href="https://discord.com/invite/sNTXWn4" target="_blank">Come visit my Discord</a></h5>
<p>Version:<br> A:0 D:1 O:8</p>
<p>Version:<br> A:0 D:1 O:0.8</p>
</div>
</div>
</div>

View File

@ -1,7 +1,6 @@
from enum import Enum
import time
import config as config
import db
import tts
import credentials
@ -16,7 +15,6 @@ import utilities_script as utility
class User_Module():
def __init__(self):
super().__init__()
self.dbCredential: credentials.DB_Credential
self.MessageLog:list = []
self.commands = command_loader.load_commands_new(AbstractCommand.CommandType.Praxis)
self.UseFlagTypeMap = { # this is a mapping of the UserFlagTypes enum to function pointers
@ -133,7 +131,4 @@ class UserFlag():
if __name__ == "__main__":
testModule = User_Module()
credentials_manager = credentials.Credentials_Module()
credentials_manager.load_credentials()
testModule.dbCredential = credentials_manager.find_DB_Credential(config.credentialsNickname)
testModule.main()