framework-lib 0.1.2__tar.gz

framework_lib-0.1.2/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: framework-lib
+Version: 0.1.2
+Summary: Python Framework Library, expandable, provides support for Console, Tkinter and Pygame.
+Author-email: Ad1Ad1 <help91922@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Ad1Ad1/game-framework
+Project-URL: Issues, https://github.com/Ad1Ad1/game-framework/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Quick Start and PyPI guide for Page Framework(v1.0)
+
+## Useful Links
+
+[View official API documentation](https://github.com/Ad1Ad1/game-framework/blob/main/README.md)
+
+[View official examples page](https://github.com/Ad1Ad1/game-framework/blob/main/EXAMPLES.md)
+
+## Installation
+First, install the framework with this command
+
+```shell
+pip install framework-lib
+```
+
+## Project creation
+Now, create a new project(maybe in a separate folder) with this command
+```shell
+framework-lib project create {name}
+```
+Open created folder. List contents with this command:
+```shell
+ls
+```
+You should see something like this
+
+```plaintext
+Mode                 LastWriteTime         Length Name
+----                 -------------         ------ ----
+-a----        10.07.2026     19:53           4294 data.py
+-a----        10.07.2026     19:53          72680 models.py
+-a----        10.07.2026     19:53              2 models_requirements.json
+-a----        10.07.2026     19:53           6578 program.py
+```
+
+Now create your file there. 
+
+## What to use?
+Choose one from our examples or create your own

framework_lib-0.1.2/README.md

@@ -0,0 +1,39 @@
+# Quick Start and PyPI guide for Page Framework(v1.0)
+
+## Useful Links
+
+[View official API documentation](https://github.com/Ad1Ad1/game-framework/blob/main/README.md)
+
+[View official examples page](https://github.com/Ad1Ad1/game-framework/blob/main/EXAMPLES.md)
+
+## Installation
+First, install the framework with this command
+
+```shell
+pip install framework-lib
+```
+
+## Project creation
+Now, create a new project(maybe in a separate folder) with this command
+```shell
+framework-lib project create {name}
+```
+Open created folder. List contents with this command:
+```shell
+ls
+```
+You should see something like this
+
+```plaintext
+Mode                 LastWriteTime         Length Name
+----                 -------------         ------ ----
+-a----        10.07.2026     19:53           4294 data.py
+-a----        10.07.2026     19:53          72680 models.py
+-a----        10.07.2026     19:53              2 models_requirements.json
+-a----        10.07.2026     19:53           6578 program.py
+```
+
+Now create your file there. 
+
+## What to use?
+Choose one from our examples or create your own

framework_lib-0.1.2/framework_lib/data.py

@@ -0,0 +1,156 @@
+"""data.py"""
+import json
+from models import ErrorForm, ErrorHelper
+import sys
+import shutil
+import os
+
+class Database:
+	def __init__(self, path, page, initial={}, sinit=False):
+		asr=["page", "path to database", "initial data"]
+		args=[page, path, initial]
+		types=[str, str, dict]
+		self.c=ErrorHelper(asr, args, types)
+		self.pat=path
+		self.p=page
+		self.i=initial
+		self.sinit=sinit
+	
+	def new(self):
+		if self.c:
+			return 1
+		try:
+			with open(self.pat, "w") as db:
+				json.dump(self.i, db, indent=4)
+			return 0
+		except:
+			ErrorForm(f"Could not create database {self.pat}: invalid file path", self.p, "102 DATABASE ERROR").call()
+			self.c=True
+			return 1
+	
+	def pageswap(self, pgnew):
+		c=ErrorHelper(["page"], [pgnew], [str])
+		if not self.c and not c:
+			self.p=pgnew
+			return 0
+		return 1
+	def change(self, name, to, total=False):
+		c=ErrorHelper(["page", "total data marker"], [self.p, total], [str, bool])
+		asr=["page", "field name"]
+		args=[self.p, name]
+		types=[str, str]
+		if not c and not self.c:
+				if total:
+					asr.append("to")
+					args.append(to)
+					types.append(dict)
+				if True:
+					c=c or ErrorHelper(asr, args, types)
+					if not c:
+						data={}
+						try:
+							with open(self.pat, "r") as db:
+								data=json.load(db)
+						except FileNotFoundError:
+							ErrorForm("Database file was not found. A new file will be created.", self.p, "102 DATABASE ERROR").call()
+							self.new()
+							if self.c:
+								return 1
+						if not total:
+							try:
+								data[name]=to
+							except:
+								ErrorForm(f"Field {name} is badly defined in this database.", self.p, "102 DATABASE ERROR").call()
+								return 1
+						with open(self.pat, "w") as db:
+							if total:
+								json.dump(to, db, indent=4)
+							else:
+								json.dump(data, db, indent=4)
+							return 0
+								
+		return 1
+		
+	def retrieve(self, name, total=False):
+			if self.c:
+				return "ERR"
+			asr=["page", "total data marker", "name"]
+			args=[self.p, name, total]
+			types=[str, str, bool]
+			c=ErrorHelper(asr, args, types)
+			if not c:
+				dt={}
+				err=False
+				try:
+					with open(self.pat, "r") as db:
+						dt=json.load(db)
+				except FileNotFoundError:
+					if not self.sinit:
+						ErrorForm("Database file was not found.",self.p, "102 DATABASE ERROR").call()
+					err=True
+				except json.JSONDecodeError:
+					ErrorForm("Database file was not decoded properly.", self.p, "102 DATABASE ERROR").call()
+					err=True
+				if err:
+					return "ERR"
+				if total:
+					return dt
+				else:
+					try:
+						return dt[name]
+					except:
+						if not self.sinit:
+							ErrorForm(f"Field {name} is badly defined in this database.", self.p, "102 DATABASE ERROR").call()
+			return "ERR"
+	def delete(self, name, total=False):
+		c=ErrorHelper(["page", "total data marker"], [self.p, total], [str, bool])
+		asr=["page", "field name"]
+		args=[self.p, name]
+		types=[str, str]
+		if not c and not self.c:
+				if True:
+					c=c or ErrorHelper(asr, args, types)
+					if not c:
+						data={}
+						try:
+							with open(self.pat, "r") as db:
+								data=json.load(db)
+						except FileNotFoundError:
+							ErrorForm("Database file was not found. A new file will be created.", self.p, "102 DATABASE ERROR").call()
+							self.new()
+							if self.c:
+								return 1
+						if not total:
+							try:
+								del data[name]
+							except:
+								ErrorForm(f"Field {name} is badly defined in this database.", self.p, "102 DATABASE ERROR").call()
+								return 1
+						with open(self.pat, "w") as db:
+							if total:
+								json.dump({}, db, indent=4)
+							else:
+								json.dump(data, db, indent=4)
+							return 0
+								
+		return 1
+	def upload(self, img):
+		c=ErrorHelper(["page", "image file path"], [self.p, img], [str, str])
+		if c:
+			return 1
+		strk=""
+		for x in range(len(img)):
+			if img[x]=="/":
+				strk=""
+			else:
+				strk+=img[x]
+		dest=f"./uploads/{strk}"
+		os.makedirs("./uploads", exist_ok=True)
+		try:
+		    shutil.copy(img, dest)
+		    return 0
+		except FileNotFoundError:
+		    ErrorForm(f"Invalid directory or file for upload.", self.p, type="104 UPLOAD ERROR").call()
+		except PermissionError:
+		    ErrorForm(f"Upload directory has an invalid permission setting. Please adjust the settings to proceed.", self.p, type="104 UPLOAD ERROR").call()
+		return 1

framework_lib-0.1.2/framework_lib/framework.py

@@ -0,0 +1,139 @@
+import os
+import argparse
+import shutil
+import inspect
+import models
+import program
+import data
+import warnings
+
+def main():
+    datapath, programpath, modelspath=inspect.getfile(data), inspect.getfile(program), inspect.getfile(models)
+
+    working_dir=os.getcwd()
+
+    parser=argparse.ArgumentParser(description="Manage framework")
+    subparsers = parser.add_subparsers(dest='function', required=True, help="function to execute")
+    subparsers.add_parser('view_models_packs')
+
+    register_parser = subparsers.add_parser('register_models_pack')
+    register_parser.add_argument('name', type=str, help="name of pack to register")
+    register_parser.add_argument("-f", "--folder",help="folder where to execute function")
+
+    delete_parser=subparsers.add_parser('delete_models_pack')
+    delete_parser.add_argument('name', type=str, help="name of pack to delete")
+    delete_parser.add_argument("-f", "--folder",help="folder where to execute function")
+
+    project_parser = subparsers.add_parser('project')
+    project_subparsers = project_parser.add_subparsers(dest='project_function', required=True, help="project function to execute")
+
+    create_parser = project_subparsers.add_parser('create')
+    create_parser.add_argument('name', type=str, help="name of project to create")
+    create_parser.add_argument("-f", "--folder",help="folder where to execute function")
+    create_parser.add_argument("-n", "--requirementfilename",help="custom requirement file name")
+
+    add_requirement_parser=project_subparsers.add_parser("add_requirement")
+    add_requirement_parser.add_argument('name', type=str, help="name of requirement to add")
+    add_requirement_parser.add_argument("-f", "--folder",help="folder where to execute function")
+    add_requirement_parser.add_argument("-n", "--requirementfilename",help="custom requirement file name")
+
+    delete_requirement_parser=project_subparsers.add_parser("delete_requirement")
+    delete_requirement_parser.add_argument('name', type=str, help="name of requirement to delete")
+    delete_requirement_parser.add_argument("-f", "--folder",help="folder where to execute function")
+    delete_requirement_parser.add_argument("-n", "--requirementfilename",help="custom requirement file name")
+    delete_requirement_parser.add_argument("-a", "--deleteallrequirements",help="marker if delete all file requirements")
+
+    import_requirement_parser=project_subparsers.add_parser("import_requirements")
+    import_requirement_parser.add_argument("-n", "--requirementfilename",help="custom requirement file name")
+    import_requirement_parser.add_argument("-i", "--ignore",help="ignore warnings(any except e) or display errors(e)")
+
+    import_requirement_parser=project_subparsers.add_parser("view_requirements")
+    import_requirement_parser.add_argument("-n", "--requirementfilename",help="custom requirement file name")
+
+    args = parser.parse_args()
+
+    try:
+        if args.folder:
+            working_dir=os.path.join(working_dir, args.folder)
+    except:
+        pass
+
+    library_dir = os.path.dirname(os.path.abspath(__file__))
+    requirements=data.Database(os.path.join(library_dir, "models_requirements.json"), "FRAMEWORK MANAGER", sinit=True)
+    if requirements.retrieve("", total=True)=="ERR":
+        requirements.new()
+        REQUIREMENTS={}
+    else:
+        REQUIREMENTS=requirements.retrieve("", total=True)
+
+    if args.function=="register_models_pack":
+        file=os.path.join(working_dir, f"{args.name}.py")
+        if os.path.isfile(file):
+            if requirements.retrieve(args.name)!="ERR":
+                parser.error(f"A models pack with name {args.name} already exists")
+            else:
+                requirements.change(args.name,[file, f"{args.name}.py"])
+        else:
+            parser.error(f"The file {args.name}.py does not exist at that path. Please check the correctness of path")
+
+    elif args.function=="delete_models_pack":
+        if requirements.retrieve(args.name)!="ERR":
+            requirements.delete(args.name)
+        else:
+            parser.error(f"A models pack with name {args.name} does not exist")
+
+    elif args.function=="view_models_packs":
+        print("=================")
+        for requirement in REQUIREMENTS:
+            print(requirement)
+        print("=================")
+        
+    elif args.function=="project":
+        req_fn="models_requirements.json" if not args.requirementfilename else args.requirementfilename
+        if args.project_function=="create":
+            os.makedirs(os.path.join(working_dir, args.name),exist_ok=True)
+            project_requirements=data.Database(os.path.join(working_dir, args.name, req_fn), "FRAMEWORK MANAGER", sinit=True)
+            project_requirements.new()
+            shutil.copy(modelspath, os.path.join(working_dir, args.name, "models.py"))
+            shutil.copy(datapath, os.path.join(working_dir, args.name, "data.py"))
+            shutil.copy(programpath, os.path.join(working_dir, args.name, "program.py"))
+        else:
+            project_requirements=data.Database(os.path.join(working_dir, req_fn), "FRAMEWORK MANAGER", sinit=True)
+        if args.project_function=="add_requirement":
+            if args.name in REQUIREMENTS:
+                if args.name in project_requirements.retrieve("",total=True):
+                    parser.error(f"A models pack with name {args.name} is already in project requirements")
+                else:
+                    project_requirements.change(args.name, 0)
+            else:
+                parser.error(f"A models pack with name {args.name} does not exist")
+
+        elif args.project_function=="delete_requirement":
+            if args.deleteallrequirements or args.deleteallrequirements==0:
+                project_requirements.delete("", total=True)
+            else:
+                if args.name in project_requirements.retrieve("",total=True):
+                    project_requirements.delete(args.name)
+                else:
+                    parser.error(f"A models pack with name {args.name} does not exist in project requirements")
+
+        elif args.project_function=="import_requirements":
+            for requirement in project_requirements.retrieve("",total=True):
+                if requirement in REQUIREMENTS:
+                    shutil.copy(REQUIREMENTS[requirement][0], os.path.join(working_dir, REQUIREMENTS[requirement][1]))
+                else:
+                    if args.ignore=="e":
+                        parser.error(f"A models pack with name {requirement} does not exist")
+                    elif args.ignore or args.ignore==0:
+                        pass
+                    else:
+                        warnings.warn(f"A models pack with name {requirement} does not exist, skipping this requirement")
+
+        elif args.project_function=="view_requirements":
+            print("=================")
+            for requirement in project_requirements.retrieve("",total=True):
+                print(requirement)
+            print("=================")
+            
+if __name__ == "__main__":
+    main()