Merge pull request #12 from botcity-dev/main

Update Legacy to include warning.
botcity-dev · Oct 3, 2024 · 2a71007 · 2a71007
2 parents 0cec956 + da2441f
commit 2a71007
Show file tree

Hide file tree

Showing 8 changed files with 69 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@
 
 # Getting Started
 
-This repository contains a cookiecutter template for generating a Bot using 
+This repository contains a cookiecutter template for generating a Bot using
 BotCity's Python Framework.
 
 To create a templated project all you need to do is:

diff --git a/hooks/pre_gen_project.py b/hooks/pre_gen_project.py
@@ -1,6 +1,7 @@
 import re
 import sys
 
+
 bot_id = '{{ cookiecutter.bot_id }}'
 
 pattern = re.compile("^[a-z|A-Z]+[a-z|A-Z|_]*[a-z|A-Z]$")

diff --git a/hooks/pre_prompt.py b/hooks/pre_prompt.py
@@ -0,0 +1,17 @@
+import sys
+
+print("*"*80)
+print("*" + "WARNING".center(78) + "*")
+print("*"*80)
+print("")
+print("You are using an outdated version of the template which is no longer recommended.")
+print("While this template works and is valid, it is strongly recommended to create a new project with the latest template version.")
+print("")
+print("Please refer to our documentation: https://documentation.botcity.dev/tutorials/python-automations/desktop/")
+print("")
+
+try:
+    input(f"Press any key to continue or use Ctrl+C to cancel.")
+except KeyboardInterrupt:
+    sys.exit("Interrupted by the user")
+    pass
diff --git a/{{ cookiecutter.bot_id.replace(' ', '_') }}/README.md b/{{ cookiecutter.bot_id.replace(' ', '_') }}/README.md
@@ -2,3 +2,10 @@
 
 {{ cookiecutter.project_short_description}}
 
+## WARNING
+
+You are using an outdated version of the template which is no longer recommended.
+
+While this template works and is valid, it is strongly recommended to create a new project with the latest template version.
+
+Please refer to our [documentation page](https://documentation.botcity.dev/tutorials/python-automations/desktop/).
diff --git a/...okiecutter.bot_id.replace(' ', '_') }}/{{ cookiecutter.bot_id.replace(' ', '_') }}/bot.py b/...okiecutter.bot_id.replace(' ', '_') }}/{{ cookiecutter.bot_id.replace(' ', '_') }}/bot.py
@@ -20,6 +20,16 @@
 Please refer to the documentation for more information at https://documentation.botcity.dev/
 """
 
+"""
+********************************************************************************
+*                                   WARNING                                    *
+********************************************************************************
+
+You are using an outdated version of the template which is no longer recommended.
+While this template works and is valid, it is strongly recommended to create a new project with the latest template version.
+
+Please refer to our documentation: https://documentation.botcity.dev/tutorials/python-automations/desktop/
+"""
 from botcity.core import DesktopBot
 # Uncomment the line below for integrations with BotMaestro
 # Using the Maestro SDK

diff --git a/...cutter.bot_id.replace(' ', '_') }}/{{ cookiecutter.bot_id.replace(' ', '_') }}/bothbot.py b/...cutter.bot_id.replace(' ', '_') }}/{{ cookiecutter.bot_id.replace(' ', '_') }}/bothbot.py
@@ -20,6 +20,17 @@
 Please refer to the documentation for more information at https://documentation.botcity.dev/
 """
 
+"""
+********************************************************************************
+*                                   WARNING                                    *
+********************************************************************************
+
+You are using an outdated version of the template which is no longer recommended.
+While this template works and is valid, it is strongly recommended to create a new project with the latest template version.
+
+Please refer to our documentation: https://documentation.botcity.dev/tutorials/python-automations/desktop/
+"""
+
 from botcity.web import WebBot, Browser
 from botcity.core import DesktopBot
 # Uncomment the line below for integrations with BotMaestro

diff --git a/...tter.bot_id.replace(' ', '_') }}/{{ cookiecutter.bot_id.replace(' ', '_') }}/custombot.py b/...tter.bot_id.replace(' ', '_') }}/{{ cookiecutter.bot_id.replace(' ', '_') }}/custombot.py
@@ -20,6 +20,17 @@
 Please refer to the documentation for more information at https://documentation.botcity.dev/
 """
 
+"""
+********************************************************************************
+*                                   WARNING                                    *
+********************************************************************************
+
+You are using an outdated version of the template which is no longer recommended.
+While this template works and is valid, it is strongly recommended to create a new project with the latest template version.
+
+Please refer to our documentation: https://documentation.botcity.dev/tutorials/python-automations/desktop/
+"""
+
 from botcity.base import BaseBot
 # Uncomment the line below for integrations with BotMaestro
 # Using the Maestro SDK

diff --git a/...ecutter.bot_id.replace(' ', '_') }}/{{ cookiecutter.bot_id.replace(' ', '_') }}/webbot.py b/...ecutter.bot_id.replace(' ', '_') }}/{{ cookiecutter.bot_id.replace(' ', '_') }}/webbot.py
@@ -20,6 +20,17 @@
 Please refer to the documentation for more information at https://documentation.botcity.dev/
 """
 
+"""
+********************************************************************************
+*                                   WARNING                                    *
+********************************************************************************
+
+You are using an outdated version of the template which is no longer recommended.
+While this template works and is valid, it is strongly recommended to create a new project with the latest template version.
+
+Please refer to our documentation: https://documentation.botcity.dev/tutorials/python-automations/desktop/
+"""
+
 from botcity.web import WebBot, Browser
 # Uncomment the line below for integrations with BotMaestro
 # Using the Maestro SDK