sbuilder 1.1a0__tar.gz

sbuilder-1.1a0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: sbuilder
+Version: 1.1a0
+Summary: A simple Python library to build and run tasks.
+Author: zboxjpg
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# SimpleBuilder
+Simple builder is simple python library which I made for myself to provide simple building operations *(and not use .sh/.bat files)*.
+
+# Examples
+## Running an OS specific command
+```py
+from simple_builder import *
+
+platform = GetPlatform()
+cmd = ""
+
+if platform == Platform.WIN32:
+    cmd = "python"
+else:
+    cmd = "python3"
+
+b = Builder()
+t = Task(cmd)
+t.AddFlag("-v")
+t.AddArg("main.py")
+b.AddTask(t)
+b.CMDRun()
+```
+
+## Working with `Status`
+```py
+from simple_builder import *
+
+t_compile = Task("gcc")
+t_compile.AddArg("main", "-o")
+t_compile.AddArg("src/main.c")
+
+t_run = Task("./main")
+
+b = Builder()
+b.AddTask(t_compile)
+
+if b.CMDRun() == Status.OK:
+    b.ClearTasks()
+    b.AddTask(t_run)
+    b.CMDRun()
+```
+
+# Documentation
+
+## Functions
+func `GetPlatform()` - get system platform
+
+| System                         | Value             |
+|--------------------------------|-------------------|
+| Linux                          | Platform.LINUX    |
+| Windows                        | Platform.WIN32    |
+| Windows/Cygwin                 | Platform.CYGWIN   |
+| Windows/MSYS2<br>Windows/MinGW | Platform.MSYS     |
+| Mac OS X                       | Platform.MACOSX   |
+| OS/2                           | Platform.OS2      |
+| OS/2 EMX                       | Platform.OS2EMX   |
+| RiscOS                         | Platform.RISCOS   |
+| AtheOS                         | Platform.ATHEOS   |
+| FreeBSD 6                      | Platform.FREEBSD6 |
+| FreeBSD 7                      | Platform.FREEBSD7 |
+| FreeBSD 8                      | Platform.FREEBSD8 |
+| FreeBSD N                      | Platform.FREEBSDN |
+
+## class `Task(cmd, com)`
+- param `cmd` - command to run (e.g. "python", "gcc", etc.)
+- param `com` - print comment instead of standard log
+
+func `AddFlag(flag)` - add flag to task (e.g. `.AddFlag("-v")`). This is a fluent method that returns the instance itself for chaining.
+
+func `AddArg(arg, flag)` - add arg to task (e.g. `.AddArg("main.c")`, `.AddArg`). This is a fluent method that returns the instance itself for chaining.
+
+func `GetFullTask()` - return task as list (e.g. `.GetFullTask()` will return `['gcc', 'main.c', '-o', './app']`)
+
+## class `Builder()`
+func `AddTask(task)` - add task to builder. This is a fluent method that returns the instance itself for chaining.
+
+func `ClearTasks()` - remove all tasks. This is a fluent method that returns the instance itself for chaining.
+
+func `CMDRun()` - run tasks synchronously. This is a fluent method that returns the instance itself for chaining.

sbuilder-1.1a0/README.md

@@ -0,0 +1,80 @@
+# SimpleBuilder
+Simple builder is simple python library which I made for myself to provide simple building operations *(and not use .sh/.bat files)*.
+
+# Examples
+## Running an OS specific command
+```py
+from simple_builder import *
+
+platform = GetPlatform()
+cmd = ""
+
+if platform == Platform.WIN32:
+    cmd = "python"
+else:
+    cmd = "python3"
+
+b = Builder()
+t = Task(cmd)
+t.AddFlag("-v")
+t.AddArg("main.py")
+b.AddTask(t)
+b.CMDRun()
+```
+
+## Working with `Status`
+```py
+from simple_builder import *
+
+t_compile = Task("gcc")
+t_compile.AddArg("main", "-o")
+t_compile.AddArg("src/main.c")
+
+t_run = Task("./main")
+
+b = Builder()
+b.AddTask(t_compile)
+
+if b.CMDRun() == Status.OK:
+    b.ClearTasks()
+    b.AddTask(t_run)
+    b.CMDRun()
+```
+
+# Documentation
+
+## Functions
+func `GetPlatform()` - get system platform
+
+| System                         | Value             |
+|--------------------------------|-------------------|
+| Linux                          | Platform.LINUX    |
+| Windows                        | Platform.WIN32    |
+| Windows/Cygwin                 | Platform.CYGWIN   |
+| Windows/MSYS2<br>Windows/MinGW | Platform.MSYS     |
+| Mac OS X                       | Platform.MACOSX   |
+| OS/2                           | Platform.OS2      |
+| OS/2 EMX                       | Platform.OS2EMX   |
+| RiscOS                         | Platform.RISCOS   |
+| AtheOS                         | Platform.ATHEOS   |
+| FreeBSD 6                      | Platform.FREEBSD6 |
+| FreeBSD 7                      | Platform.FREEBSD7 |
+| FreeBSD 8                      | Platform.FREEBSD8 |
+| FreeBSD N                      | Platform.FREEBSDN |
+
+## class `Task(cmd, com)`
+- param `cmd` - command to run (e.g. "python", "gcc", etc.)
+- param `com` - print comment instead of standard log
+
+func `AddFlag(flag)` - add flag to task (e.g. `.AddFlag("-v")`). This is a fluent method that returns the instance itself for chaining.
+
+func `AddArg(arg, flag)` - add arg to task (e.g. `.AddArg("main.c")`, `.AddArg`). This is a fluent method that returns the instance itself for chaining.
+
+func `GetFullTask()` - return task as list (e.g. `.GetFullTask()` will return `['gcc', 'main.c', '-o', './app']`)
+
+## class `Builder()`
+func `AddTask(task)` - add task to builder. This is a fluent method that returns the instance itself for chaining.
+
+func `ClearTasks()` - remove all tasks. This is a fluent method that returns the instance itself for chaining.
+
+func `CMDRun()` - run tasks synchronously. This is a fluent method that returns the instance itself for chaining.

sbuilder-1.1a0/pyproject.toml

@@ -0,0 +1,13 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sbuilder"
+version = "1.1a"
+description = "A simple Python library to build and run tasks."
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [{name = "zboxjpg"}]
+license = {text = "MIT"}
+dependencies = []

sbuilder-1.1a0/sbuilder/__init__.py

@@ -0,0 +1 @@
+from .sbuilder import *

sbuilder-1.1a0/sbuilder/sbuilder.py

@@ -0,0 +1,121 @@
+# Simple library to build stuff
+# (c) zboxjpg
+
+from datetime import datetime
+from enum import Enum, auto
+import sys
+import time
+
+class Platform(Enum):
+    LINUX    = auto()
+    WIN32    = auto()
+    CYGWIN   = auto()
+    MSYS     = auto()
+    MACOSX   = auto()
+    OS2      = auto()
+    OS2EMX   = auto()
+    RISCOS   = auto()
+    ATHEOS   = auto()
+    FREEBSD6 = auto()
+    FREEBSD7 = auto()
+    FREEBSD8 = auto()
+    FREEBSDN = auto()
+
+def GetPlatform():
+    match sys.platform:
+        case "linux" | "linux2": return Platform.LINUX
+        case "win32": return Platform.WIN32
+        case "cygwin": return Platform.CYGWIN
+        case "msys": return Platform.MSYS
+        case "darwin": return Platform.MACOSX
+        case "os2": return Platform.OS2
+        case "os2emx": return Platform.OS2EMX
+        case "riscos": return Platform.RISCOS
+        case "atheos": return Platform.ATHEOS
+        case "freebsd6": return Platform.FREEBSD6
+        case "freebsd7": return Platform.FREEBSD7
+        case "freebsd8": return Platform.FREEBSD8
+        case "freebsdN": return Platform.FREEBSDN
+        case _: raise Exception("Undefined platform `%s`(???)" % (sys.platform))
+
+class Status(Enum):
+    OK      = auto()
+    ERROR   = auto()
+
+class Task():
+    """Task class, that contains task itself and args
+    
+    cmd -> command
+
+    com -> comment (def. None)"""
+    def __init__(self, cmd, com = None):
+        self.args = []
+        self.cmd = cmd
+        self.com = com
+
+    def AddFlag(self, flag = ""):
+        """
+        Add flag to task
+        
+        e.g. .AddArg("-v")
+        """
+        self.args.append(flag)
+
+        return self
+    
+    def AddArg(self, arg = "", flag = ""):
+        """
+        Add argument to task
+
+        e.g. .AddArg("main.cpp") OR .AddArg("app", "-o")
+        """
+        if flag: self.args.extend([flag, arg])
+        else: self.args.append(arg)
+
+        return self
+
+    def GetFullTask(self):
+        """
+        Return task as list
+
+        e.g. ['g++', 'main.cpp', '-o', 'app']
+        """
+        full_task = [self.cmd]
+        full_task.extend(self.args)
+        return full_task
+    
+class Builder():
+    "Builder class that contains tasks and used to run tasks sync & async"
+    def __init__(self):
+        self.tasks : list[Task] = []
+
+    def ClearTasks(self):
+        self.tasks = []
+        return self
+
+    def AddTask(self, task : Task):
+        """
+        Add task to builder
+
+        e.g. .AddTask(Task("g++").AddArg("main.cpp").AddArg("app", "-o"))
+        """
+        self.tasks.append(task)
+        return self
+
+    def CMDRun(self):
+        "Run tasks"
+        start_time = time.time()
+        import subprocess as sp
+        for task in self.tasks:
+            ft = task.GetFullTask()
+            if task.com: print(task.com)
+            else: 
+                print("[SB-CMD]", datetime.now().strftime("%H.%M.%S"), "RUNNING > ", " ".join(ft))
+            proc = sp.run(ft)
+            res_time = time.time() - start_time
+            if proc.returncode:
+                print("\n[SB-CMD]", datetime.now().strftime("%H.%M.%S"), "EXITCODE > ", proc.returncode)
+                print(f"[SB-CMD] Build finished in just {res_time:.3f}s")
+                return Status.ERROR
+            print(f"[SB-CMD] Build finished in just {res_time:.3f}s")
+        return Status.OK

sbuilder-1.1a0/sbuilder.egg-info/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: sbuilder
+Version: 1.1a0
+Summary: A simple Python library to build and run tasks.
+Author: zboxjpg
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# SimpleBuilder
+Simple builder is simple python library which I made for myself to provide simple building operations *(and not use .sh/.bat files)*.
+
+# Examples
+## Running an OS specific command
+```py
+from simple_builder import *
+
+platform = GetPlatform()
+cmd = ""
+
+if platform == Platform.WIN32:
+    cmd = "python"
+else:
+    cmd = "python3"
+
+b = Builder()
+t = Task(cmd)
+t.AddFlag("-v")
+t.AddArg("main.py")
+b.AddTask(t)
+b.CMDRun()
+```
+
+## Working with `Status`
+```py
+from simple_builder import *
+
+t_compile = Task("gcc")
+t_compile.AddArg("main", "-o")
+t_compile.AddArg("src/main.c")
+
+t_run = Task("./main")
+
+b = Builder()
+b.AddTask(t_compile)
+
+if b.CMDRun() == Status.OK:
+    b.ClearTasks()
+    b.AddTask(t_run)
+    b.CMDRun()
+```
+
+# Documentation
+
+## Functions
+func `GetPlatform()` - get system platform
+
+| System                         | Value             |
+|--------------------------------|-------------------|
+| Linux                          | Platform.LINUX    |
+| Windows                        | Platform.WIN32    |
+| Windows/Cygwin                 | Platform.CYGWIN   |
+| Windows/MSYS2<br>Windows/MinGW | Platform.MSYS     |
+| Mac OS X                       | Platform.MACOSX   |
+| OS/2                           | Platform.OS2      |
+| OS/2 EMX                       | Platform.OS2EMX   |
+| RiscOS                         | Platform.RISCOS   |
+| AtheOS                         | Platform.ATHEOS   |
+| FreeBSD 6                      | Platform.FREEBSD6 |
+| FreeBSD 7                      | Platform.FREEBSD7 |
+| FreeBSD 8                      | Platform.FREEBSD8 |
+| FreeBSD N                      | Platform.FREEBSDN |
+
+## class `Task(cmd, com)`
+- param `cmd` - command to run (e.g. "python", "gcc", etc.)
+- param `com` - print comment instead of standard log
+
+func `AddFlag(flag)` - add flag to task (e.g. `.AddFlag("-v")`). This is a fluent method that returns the instance itself for chaining.
+
+func `AddArg(arg, flag)` - add arg to task (e.g. `.AddArg("main.c")`, `.AddArg`). This is a fluent method that returns the instance itself for chaining.
+
+func `GetFullTask()` - return task as list (e.g. `.GetFullTask()` will return `['gcc', 'main.c', '-o', './app']`)
+
+## class `Builder()`
+func `AddTask(task)` - add task to builder. This is a fluent method that returns the instance itself for chaining.
+
+func `ClearTasks()` - remove all tasks. This is a fluent method that returns the instance itself for chaining.
+
+func `CMDRun()` - run tasks synchronously. This is a fluent method that returns the instance itself for chaining.

sbuilder-1.1a0/sbuilder.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+pyproject.toml
+sbuilder/__init__.py
+sbuilder/sbuilder.py
+sbuilder.egg-info/PKG-INFO
+sbuilder.egg-info/SOURCES.txt
+sbuilder.egg-info/dependency_links.txt
+sbuilder.egg-info/top_level.txt

sbuilder-1.1a0/sbuilder.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sbuilder-1.1a0/sbuilder.egg-info/top_level.txt

@@ -0,0 +1 @@
+sbuilder

sbuilder-1.1a0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+