From baf4ce69baed7e52b0c416d1482b506a63a258bc Mon Sep 17 00:00:00 2001 From: Innovation Date: Sun, 16 Jul 2023 15:14:25 -0500 Subject: [PATCH] Got pytest working. Basic boilerplate code done. Took a lot of work since I don't normally use Python for projects that are meant to be scaled. --- .gitignore | 4 ++++ plugboard-chatbot-framework/setup.py | 14 ------------ .../tests/test_matrix.py | 0 .../plugboardChatbotFramework}/__init__.py | 0 .../client}/__init__.py | 0 .../client/client.py | 12 ++++++++++ .../discord}/__init__.py | 0 .../matrix/__init__.py | 1 + .../matrix/matrix.py | 22 +++++++++++++++++++ plugboardChatbotFramework/setup.py | 19 ++++++++++++++++ .../tests/discord}/test_discord.py | 0 .../tests/matrix/test_matrix.py | 11 ++++++++++ .../tests/test_all.py | 0 13 files changed, 69 insertions(+), 14 deletions(-) create mode 100644 .gitignore delete mode 100644 plugboard-chatbot-framework/setup.py delete mode 100644 plugboard-chatbot-framework/tests/test_matrix.py rename {plugboard-chatbot-framework/plugboard-chatbot-framework => plugboardChatbotFramework/plugboardChatbotFramework}/__init__.py (100%) rename {plugboard-chatbot-framework/plugboard-chatbot-framework/discord => plugboardChatbotFramework/plugboardChatbotFramework/client}/__init__.py (100%) create mode 100644 plugboardChatbotFramework/plugboardChatbotFramework/client/client.py rename {plugboard-chatbot-framework/plugboard-chatbot-framework/matrix => plugboardChatbotFramework/plugboardChatbotFramework/discord}/__init__.py (100%) create mode 100644 plugboardChatbotFramework/plugboardChatbotFramework/matrix/__init__.py create mode 100644 plugboardChatbotFramework/plugboardChatbotFramework/matrix/matrix.py create mode 100644 plugboardChatbotFramework/setup.py rename {plugboard-chatbot-framework/tests => plugboardChatbotFramework/tests/discord}/test_discord.py (100%) create mode 100644 plugboardChatbotFramework/tests/matrix/test_matrix.py rename {plugboard-chatbot-framework => plugboardChatbotFramework}/tests/test_all.py (100%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2c7b851 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +**/.eggs +**/.pytest_cache +**/plugboardChatbotFramework.egg-info +**/__pycache__ diff --git a/plugboard-chatbot-framework/setup.py b/plugboard-chatbot-framework/setup.py deleted file mode 100644 index 52296c6..0000000 --- a/plugboard-chatbot-framework/setup.py +++ /dev/null @@ -1,14 +0,0 @@ -from setuptools import find_packages, setup - -setup( - name='plugboard-chatbot-framework', - packages=find_packages(include=['plugboard-chatbot-framework']), - version='0.1.0', - description='Plugboard, a chatbot framework so you only have to write code once.', - author='Innovation Science', - license='GPLv3', - install_requires=['asyncio','matrix-nio','os','ping3','urllib3','configparser'], - setup_requires=['pytest-runner'], - tests_require=['pytest==4.4.1'], - test_suite='tests', -) diff --git a/plugboard-chatbot-framework/tests/test_matrix.py b/plugboard-chatbot-framework/tests/test_matrix.py deleted file mode 100644 index e69de29..0000000 diff --git a/plugboard-chatbot-framework/plugboard-chatbot-framework/__init__.py b/plugboardChatbotFramework/plugboardChatbotFramework/__init__.py similarity index 100% rename from plugboard-chatbot-framework/plugboard-chatbot-framework/__init__.py rename to plugboardChatbotFramework/plugboardChatbotFramework/__init__.py diff --git a/plugboard-chatbot-framework/plugboard-chatbot-framework/discord/__init__.py b/plugboardChatbotFramework/plugboardChatbotFramework/client/__init__.py similarity index 100% rename from plugboard-chatbot-framework/plugboard-chatbot-framework/discord/__init__.py rename to plugboardChatbotFramework/plugboardChatbotFramework/client/__init__.py diff --git a/plugboardChatbotFramework/plugboardChatbotFramework/client/client.py b/plugboardChatbotFramework/plugboardChatbotFramework/client/client.py new file mode 100644 index 0000000..c193d23 --- /dev/null +++ b/plugboardChatbotFramework/plugboardChatbotFramework/client/client.py @@ -0,0 +1,12 @@ +# baseClient.py - An abstract method that acts as a blueprint for chatbot clients. +# +# (C) Innovation Science, Katie Martin + +from abc import ABC, abstractmethod + +class baseClient(ABC): + + # Constructor + @abstractmethod + def __init__(self): + pass diff --git a/plugboard-chatbot-framework/plugboard-chatbot-framework/matrix/__init__.py b/plugboardChatbotFramework/plugboardChatbotFramework/discord/__init__.py similarity index 100% rename from plugboard-chatbot-framework/plugboard-chatbot-framework/matrix/__init__.py rename to plugboardChatbotFramework/plugboardChatbotFramework/discord/__init__.py diff --git a/plugboardChatbotFramework/plugboardChatbotFramework/matrix/__init__.py b/plugboardChatbotFramework/plugboardChatbotFramework/matrix/__init__.py new file mode 100644 index 0000000..ef234d7 --- /dev/null +++ b/plugboardChatbotFramework/plugboardChatbotFramework/matrix/__init__.py @@ -0,0 +1 @@ +import matrix diff --git a/plugboardChatbotFramework/plugboardChatbotFramework/matrix/matrix.py b/plugboardChatbotFramework/plugboardChatbotFramework/matrix/matrix.py new file mode 100644 index 0000000..0823c62 --- /dev/null +++ b/plugboardChatbotFramework/plugboardChatbotFramework/matrix/matrix.py @@ -0,0 +1,22 @@ +# matrixClient.py - Implements baseClient.py, for use with Matrix homeservers. +# +# (C) Innovation Science, Katie Martin + +from abc import ABC,abstractmethod +import plugboardChatbotFramework.client.client as client + +# I don't like this, but Python seems to be wanting to force my hand. +class matrixClient(client.baseClient): + username='' + password='' + botChannel='' + serverAddr='' + serverWebAddr='' + + # Constructor + def __init__(self, username='', password='', botChannel='', serverAddr='', serverWebAddr=''): + self.username = username + self.password = password + self.botChannel = botChannel + self.serverAddr = serverAddr + self.serverWebAddr = serverWebAddr diff --git a/plugboardChatbotFramework/setup.py b/plugboardChatbotFramework/setup.py new file mode 100644 index 0000000..b96924b --- /dev/null +++ b/plugboardChatbotFramework/setup.py @@ -0,0 +1,19 @@ +from setuptools import find_packages, setup +#print(find_packages(include=['plugboardChatbotFramework'])) + +setup( + name='plugboardChatbotFramework', + packages=find_packages(), + version='0.1.0', + description='Plugboard, a chatbot framework so you only have to write code once.', + author='Innovation Science', + license='GPLv3', + install_requires=['asyncio','matrix-nio','ping3','urllib3','configparser'], + setup_requires=['pytest-runner'], + tests_require=['pytest==7.4.0'], + test_suite='tests', +) + +# install_requires=['asyncio','matrix-nio','os','ping3','urllib3','configparser'], +# packages=find_packages(include=['plugboard-chatbot-framework']), +# originally 4.4.1 diff --git a/plugboard-chatbot-framework/tests/test_discord.py b/plugboardChatbotFramework/tests/discord/test_discord.py similarity index 100% rename from plugboard-chatbot-framework/tests/test_discord.py rename to plugboardChatbotFramework/tests/discord/test_discord.py diff --git a/plugboardChatbotFramework/tests/matrix/test_matrix.py b/plugboardChatbotFramework/tests/matrix/test_matrix.py new file mode 100644 index 0000000..18215e7 --- /dev/null +++ b/plugboardChatbotFramework/tests/matrix/test_matrix.py @@ -0,0 +1,11 @@ +import plugboardChatbotFramework.matrix.matrix as matrix + +def test_init(): + client = matrix.matrixClient() + user = client.username + assert user == '' + +def test_getUsername(): + client = matrix.matrixClient() + user = client.username + assert user == '' diff --git a/plugboard-chatbot-framework/tests/test_all.py b/plugboardChatbotFramework/tests/test_all.py similarity index 100% rename from plugboard-chatbot-framework/tests/test_all.py rename to plugboardChatbotFramework/tests/test_all.py