refactor(python): restructure everything into a modern python project

Co-authored-by: Millena Queiroz <[email protected]>
Co-authored-by: Paulo H. Lamounier <[email protected]>

Author: 3 people

.gitignore

@@ -3,3 +3,4 @@
 __pycache__/
 .env
 .junk
+/src/Unimancer_Interface.egg-info

makefile

@@ -1,14 +1,15 @@
 .PHONY: config build start stop rmv interface
 
-VENV_DIR := ./.venv
+VENV_DIR := $(CURDIR)/.venv
+PYTHONPATH=$(CURDIR)/source
 
 config:
 	@cp .env.template .env
 	@test -d $(VENV_DIR) || python3 -m venv $(VENV_DIR)
 	@echo "Python virtual environment criado em $(VENV_DIR)"
 	@$(VENV_DIR)/bin/pip install --upgrade pip
-	@$(VENV_DIR)/bin/pip install -r requirements.txt
 	@echo "Dependencias instaladas com sucesso."
+	@python -m pip install .
 
 build:
 	@sudo docker compose up --build

pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "Unimancer-Interface"
+version = "4.0.0"
+description = "A game interface for Unimancer."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { file = "LICENSE" }
+keywords = ["setuptools", "interface", "game", "unimancer"]
+
+authors = [
+    {name = "A. Random Developer", email = "[email protected]" },
+]
+
+maintainers = [
+  { name = "A. Great Maintainer", email = "[email protected]" },
+]
+
+classifiers = []
+dependencies = [
+    "psycopg2",
+    "colorama"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/SBD1/2024.2-unimancer"
+"Bug Reports" = "https://github.com/SBD1/2024.2-unimancer/issues"
+"Source" = "https://github.com/SBD1/2024.2-unimancer"
+
+[project.scripts]
+sample = "sample:main"
+
+
+[tool.setuptools]
+package-data = { }

requirements.txt

@@ -0,0 +1,50 @@
+from database.Database import Database
+from default import populate_database
+import sys
+import logic
+import utils
+
+def main():
+
+    sqls = {
+        "./source/database/ddl/types.sql",
+        "./source/database/ddl/tables.sql",
+        "./source/database/dml/procedures.sql",
+        "./source/database/dml/triggers.sql"
+    }
+    
+    db = Database("localhost", "postgres", "postgres", "123456")
+    
+    def table_length() -> list:
+        db.cur.execute("SELECT table_name FROM information_schema.tables WHERE table_schema='public'")
+        tables = db.cur.fetchall()
+        return len(tables)
+    
+    def init_database():
+        for sql in sqls:
+            db.execute_file(sql)
+        utils.debug("")
+        populate_database(db)
+    
+    # Process command line arguments.
+    if len(sys.argv) > 1:
+        arg = sys.argv[1]
+        if arg == "delete" or arg == "reset":
+            db.delete_tables()
+            if arg == "reset":
+                init_database()
+        exit(0)
+    
+    if table_length() == 0:
+        utils.debug("Nenhuma tabela encontrada. Criando banco de dados...")
+        utils.debug("Banco de dados e tabelas criados com sucesso!")
+        init_database()
+    
+    while True:
+        character = logic.main_menu(db.conn)
+        if not character:
+            utils.debug("Nenhum personagem retornado, saindo.")
+            exit(0)
+        
+        while logic.game(db.conn, character):
+            pass

source/main.py

@@ -1,7 +1,7 @@
 import random
 from colorama import Fore, Style
 import time
-import logic as logic
+import src.logic as logic
 from utils import debug, error
 import interface.display as display
 from character import Character

src/__init__.py

@@ -12,25 +12,11 @@ def questers(db: Database):
                 "Ancião",
                 3,
                 "Velho homem aborrecido com a vida.",
-                "Bem-vindo, jovem. Você deseja embarcar em uma jornada?"
-            ),
-            (
-                "Elysia",
-                2,
-                "descr",
-                "Eu vi algo estranho nas montanhas... Está disposto a investigar?"
-            ),
-            (
-                "Isolde",
-                1,
-                "Você está pronto para enfrentar o que há de mais perigoso neste mundo?",
-                "...Dialogo..."
-            ),
-            (
-                "Kael",
-                4,
-                "Tenho algumas pistas para você, mas isso vai exigir coragem.",
-                "...Dialogo..."
+                """Tsk! Malditas pragas... esses ratos estão por toda parte!
+                Entram nos celeiros, roem nossos suprimentos e nem os templos escaparam deles!
+                Se ninguém fizer nada, logo estaremos dividindo nossas camas com essa praga!
+                Se você puder nos ajudar a exterminá-los, seremos imensamente gratos. Mate-os e lhe darei uma recompensa justa!
+                """
             ),
         ]
 

source/character.py src/character.py

@@ -1,5 +1,5 @@
 from database import Database
-from database.defaults.storage.storage import storage
+from database.data.storage.storage import storage
 from utils import debug, error
 from colorama import Style
 

source/combat.old.py src/combat.old.py

@@ -3,7 +3,7 @@ CREATE TABLE item (
     tipo TIPO_ITEM NOT NULL,
     descricao TEXT NOT NULL,
     -- É o numero de inimigos que você tem que matar para conseguir o item.
-    -- Chance de drop: O cálculo é: 1 / enemies_average.
+    -- Chance de drop: O cálculo é: 1 / drop_inimigos_media.
 	drop_inimigos_media INT NOT NULL CHECK (drop_inimigos_media >= 0),
 	nome VARCHAR(200) NOT NULL,
 	peso INT NOT NULL CHECK (peso >= 0),

source/combat.py src/combat.py

@@ -150,9 +150,31 @@ def get_civilian_info(conn, npc_name):
         result = cur.fetchone()
         return {
             'nome': result[0],
-            'descricao': result[1]
+            'descricao': result[1],
+            'npc_id': result[2]
         }
 
+# get quest given a quester id 
+def get_quest(conn, quester_id):
+    with conn.cursor() as cur:
+        cur.execute(
+            """
+            SELECT q.titulo, q.descricao, qu.dialogo, q.id, q.recompensa
+            FROM quest q 
+            LEFT JOIN quester qu ON qu.id = q.quester_id
+            WHERE q.quester_id = %s;
+            """, (quester_id,)
+        )
+        result = cur.fetchall()
+        return {
+            'title': result[0][0],
+            'description': result[0][1],
+            'dialog': result[0][2],
+            'quest_id': result[0][3],
+            'reward': result[0][4]
+        }
+
+
 # Function to get all spells
 def get_spells(conn, character_id):
     with conn.cursor() as cur:

source/database/Database.py src/database/Database.py

@@ -1,19 +1,13 @@
-
-from database.defaults.item.acessory import bracelet, buckle, cane, cloack, collar, gloves, hat, ring, pants, socks, boots, key
 from utils import debug, error
 from database.Database import Database
 
-from database.defaults.npc.enemy import enemies, enemies_instances
-
-from database.defaults.npc.citizen import citizens, merchants, questers
-
-from database.defaults.storage import quest, storage, enemie_storage
-
-from database.defaults.map import regions as r, sub_regions as sr, sub_regions_connections as src
-
-from database.defaults.item.scroll import area_damage, cure, damage, scroll, writted_scroll, requirements
-
-from database.defaults.item import effects, potions, potion_effect
+from database.data.item.acessory import bracelet, buckle, cane, cloack, collar, gloves, hat, ring, pants, socks, boots, key
+from database.data.npc.enemy import enemies, enemies_instances
+from database.data.npc.citizen import citizens, merchants, questers
+from database.data.storage import quest, storage, enemie_storage
+from database.data.map import regions as r, sub_regions as sr, sub_regions_connections as src
+from database.data.item.scroll import area_damage, cure, damage, scroll, writted_scroll, requirements
+from database.data.item import effects, potions, potion_effect
 
 def populate_database(db: Database):
 

source/database/defaults/item/acessory/boots.py src/database/data/item/acessory/boots.py

@@ -2,7 +2,6 @@
 import platform
 from colorama import Fore, Style
 import time
-import queries.query as query
 
 # Clean the terminal screen
 def clear_screen():
@@ -52,13 +51,27 @@ def display_npc_info(npc_nome, npc_tipo, conn):
     time.sleep(1)
 
     if npc_tipo == "Quester":
-        get_quest(npc_nome) 
+        show_quest(conn, npc_nome, descricao['npc_id'], character)
         input("Pressione Enter para continuar...") 
     else:
         print(Fore.RED + f"{npc_nome} não tem nada a dizer." + Style.RESET_ALL)
         print(Fore.MAGENTA + "Pressione 0 para voltar ao menu." + Style.RESET_ALL)
         input()
 
-def get_quest(npc_nome):
-    print(f"Você recebeu uma missão de {npc_nome}.")
-    # Adicione mais lógica conforme necessário
+def show_quest(conn, npc_name, npc_id, character):
+    quest = get_quest(conn, npc_id)
+    print(Fore.CYAN + f"\n Missão: {quest['title']}" + Style.RESET_ALL)
+    print(Fore.CYAN + f"{quest['description']}" + Style.RESET_ALL)
+    print('..')
+    time.sleep(1)
+    for line in quest['dialog'].split('\n'):
+        print(f"{npc_name} diz: {line}")
+        input("Pressione Enter para continuar...")
+    
+    accept_quest(conn, character.id, quest['quest_id'])
+    
+    print(Fore.GREEN + "\n--- COMPLETE A MISSÃO ---" + Style.RESET_ALL)
+    print(Fore.YELLOW + f"Descrição: {quest['description']}" + Style.RESET_ALL)
+    print(Fore.YELLOW + f"Recompensa: {quest['reward']}" + Style.RESET_ALL)
+    print(Fore.MAGENTA + "Pressione Enter para continuar..." + Style.RESET_ALL)
+    input()

source/database/defaults/item/acessory/bracelet.py src/database/data/item/acessory/bracelet.py

@@ -1,13 +1,12 @@
 from colorama import Style, Fore
-from interface.display import clear_screen
-from queries.query import list_item_inventory
+import database.dql.query as query
 from character import Character
 
 def display(character, conn):
     print(f"Inventário de === {character.nome} ===")
     print("-" * 40)
 
-    items = list_item_inventory(conn, character.id)
+    items = query.list_item_inventory(conn, character.id)
 
     if not items:
        print("O inventário está vazio.")

source/database/defaults/item/acessory/buckle.py src/database/data/item/acessory/buckle.py

@@ -1,6 +1,6 @@
 from colorama import Fore, Style
 import psycopg2
-from queries.query import get_subregions_character, list_npcs_subregion, list_enemys_subregion
+from database.dql.query import get_subregions_character, list_npcs_subregion, list_enemys_subregion
 from character import Character
 
 # Function to get subregion description

source/database/defaults/item/acessory/cane.py src/database/data/item/acessory/cane.py

@@ -1,7 +1,7 @@
 import interface.display as display
 import interface.inventory as inventory
 import interface.world_info as world_info
-import queries.query as query
+import database.dql.query as query
 import combat as combat
 from colorama import Fore, Style
 from character import Character