sm-blueprint-lib 0.0.6__py3-none-any.whl → 0.0.8__py3-none-any.whl

sm_blueprint_lib/parts/__init__.py

@@ -0,0 +1,5 @@
+from .barrierblock import *
+from .logicgate import *
+from .sensor import *
+# from .switch import * # not finished
+from .timer import *

sm_blueprint_lib/prebuilds/__init__.py

@@ -0,0 +1,12 @@
+from .adder import *
+from .barrel_shifter import *
+from .clock40hz import *
+from .comparator import *
+from .counter import *
+from .decoder import *
+from .distance_sensor import *
+from .ram import *
+from .register import *
+from .rom import *
+from .timer_ram_cached import * # not finished
+from .timer_ram_multiclient import *

sm_blueprint_lib/utils.py

@@ -1,6 +1,7 @@
 from dataclasses import asdict
 from json import load, dump, loads, dumps
 from math import ceil, log2
+from typing import Sequence
 
 from numpy import ndarray
 
@@ -12,7 +13,7 @@ from .parts.timer import Timer
 from .pos import Pos
 
 
-def load_blueprint(path):
+def load_blueprint(path: str):
     """Load a blueprint from a path file (normally a blueprint.json).
 
     Args:
@@ -25,7 +26,7 @@ def load_blueprint(path):
         return Blueprint(**load(fp))
 
 
-def save_blueprint(path, bp: Blueprint):
+def save_blueprint(bp: Blueprint, path: str):
     """Save a blueprint to a file (normally a blueprint.json).
 
     Args:
@@ -36,7 +37,7 @@ def save_blueprint(path, bp: Blueprint):
         return dump(asdict(bp), fp, sort_keys=True, separators=(',', ':'))
 
 
-def load_string(str):
+def load_blueprint_from_string(str: str):
     """Load a blueprint from a json string.
 
     Args:
@@ -48,7 +49,7 @@ def load_string(str):
     return Blueprint(**loads(str))
 
 
-def dump_string(bp: Blueprint):
+def dump_string_from_blueprint(bp: Blueprint):
     """Dump a blueprint into a json-formatted string.
 
     Args:
@@ -110,9 +111,17 @@ def connect(_from, _to, *, parallel=True):
                 connect(_from, subto, parallel=parallel)
 
 
-def check_pos(pos):
+def check_pos(pos: Sequence) -> Pos:
+    """Converts a Sequence into a Pos class if it wasn't already.
+
+    Args:
+        pos (Sequence): The Sequence to be converted.
+
+    Returns:
+        Pos: The converted Pos.
+    """
     if not isinstance(pos, Pos):
-        pos = Pos(*pos)
+        pos = Pos(*list(pos))
     return pos
 
 

sm_blueprint_lib-0.0.8.dist-info/METADATA

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: sm_blueprint_lib
+Version: 0.0.8
+Summary: Scrap Mechanic Library for Blueprint manipulation.
+Project-URL: Homepage, https://github.com/MauriceTZ/sm_blueprint_lib
+Project-URL: Issues, https://github.com/MauriceTZ/sm_blueprint_lib/issues
+Author-email: Maurice <mauriciotorrez00@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: numpy
+Description-Content-Type: text/markdown
+
+# sm_blueprint_lib
+ Scrap Mechanic Library for Blueprint manipulation.
+
+## Instalation
+```sh
+pip install sm_blueprint_lib
+```
+## Usage
+```python
+import numpy as np
+
+import sm_blueprint_lib as sm
+
+# Create a Blueprint object to store your parts
+bp = sm.Blueprint()
+
+# Define your stuff as you like, ID's are generated automatically or u can create them manually
+# The controller argument is converted to the needed LogicGateController class
+# 0: and, 1: or, 2: xor, 3: nand, 4: nor, 5: xnor
+single_and = sm.LogicGate(pos=(0, 0, 0), color="1122ff", controller=0)
+single_or = sm.LogicGate(sm.Pos(0, 2, 0), "3322ff", 1)
+single_self_wired_xor = sm.LogicGate(
+    pos=sm.Pos(0, 4, 0),
+    color="5522ff",
+    # Or define it explicitly
+    controller=sm.LogicGateController(mode=2, id=9999999, controllers=[sm.ID(9999999)])
+)
+
+# Create multiple gates at the same time
+row_0 = [sm.LogicGate((x, 6, 0), "ffffff", 0) for x in range(10)]
+row_1 = [sm.LogicGate((-1, 6, z + 1), "ffffff", 0) for z in range(10)]
+# Define matrices using numpy
+matrix = np.ndarray((10, 10), dtype=sm.LogicGate)
+for x in range(10):
+    for z in range(10):
+        # Define custom rotation (xaxis, zaxis)
+        matrix[x, z] = sm.LogicGate(
+            (x, 8, z + 1), "000000", 5, xaxis=1, zaxis=2)
+
+single_nor = sm.LogicGate(sm.Pos(0, 11, 0), "ee22ff", 4)
+
+row_2 = [sm.LogicGate((x, 13, 0), "ffffff", 0) for x in range(10)]
+row_3 = [sm.LogicGate((-1, 13, z + 1), "ffffff", 0) for z in range(10)]
+
+# Simple Timer loop
+loop = [sm.LogicGate((4, 0, 0), "987654"),
+        # TimerController can be passed as (seconds, ticks)
+        sm.Timer((5, 0, 0), "3210ff", (1, 0)),
+        sm.LogicGate((6, 0, 0), "eeddcc", 3)]
+
+# Connect stuff
+# 1 to 1
+sm.connect(single_and, single_or)
+sm.connect(single_or, single_self_wired_xor)
+sm.connect(row_0, row_1)    # With parallel=True (ie row to row)
+# 1 to many
+sm.connect(single_self_wired_xor, row_0)
+sm.connect(row_0, matrix)
+# Many to 1
+sm.connect(matrix, single_nor)
+# Many to many
+# With parallel=False (ie everything connects to everything)
+sm.connect(row_2, row_3, parallel=False)
+# You can also chain single gate connections
+loop[0].connect(loop[1]).connect(loop[2]).connect(loop[0])
+
+# Put all parts into the blueprint
+# Note that it doesn't care if it's a single gate or arrays
+bp.add(single_and, single_or, single_self_wired_xor,
+       row_0, row_1, matrix, single_nor, row_2, row_3, loop)
+
+# Finally, save the blueprint into a file or dump it as a string
+print(sm.dump_string_from_blueprint(bp))
+path = "path/to/your/blueprint/folder/blueprint.json"
+sm.save_blueprint(bp, path)
+```
+
+### Results
+#### 1 to 1 and loop
+![1 to 1 and loop](1to1andloop.png)
+#### Row to row and 1 to many
+![row to row and 1 to many](rowtorowand1tomany.png)
+#### Many to 1 and many to many
+![many to 1 and many to many](manytooneandmanytomany.png)

{sm_blueprint_lib-0.0.6.dist-info → sm_blueprint_lib-0.0.8.dist-info}/RECORD

@@ -5,7 +5,7 @@ sm_blueprint_lib/bounds.py,sha256=fH-i8PdlZVg8qlEd3FmIf5mbx4RKhdBOFRAe5cSWWiI,18
 sm_blueprint_lib/constants.py,sha256=mll05HrWLGCETzvQlkDPRMBe5HJLAGn5rRkxs5gJ71E,710
 sm_blueprint_lib/id.py,sha256=5sBHC8qZJnCaizSBs4KGS1dnZHOSdoq5wkuIpuYNRnw,71
 sm_blueprint_lib/pos.py,sha256=W0yaIg_nYgRqFwSkHlpd7Tfr69XSVwjTY1DfICHXoDo,411
-sm_blueprint_lib/utils.py,sha256=g3psyklJ6D1PvyL-MQPDN1TqW7Q1JVr1eSuoIdJy0Ro,4819
+sm_blueprint_lib/utils.py,sha256=oT4s7kpY7-OSFDFiJt48fr7Yp_dBkGz45iOBiwnNcHE,5109
 sm_blueprint_lib/bases/controllers/basecontroller.py,sha256=VFS5J7kGQ8vfWBFjiTPVfXXjyMwJ1VqA3mYuh7Z_8ak,624
 sm_blueprint_lib/bases/controllers/baselogiccontroller.py,sha256=lDoDt9NKFu01CqyJE09_bq9oDeYK7T-fERO54kd-sFA,290
 sm_blueprint_lib/bases/controllers/logicgatecontroller.py,sha256=wzw8kdt65Zg6ucNNy47V3-okYod_ea2NH8erfjRu7uw,223
@@ -15,11 +15,13 @@ sm_blueprint_lib/bases/parts/baseboundablepart.py,sha256=jNx_btmkCTksT6FcpHQxEVJ
 sm_blueprint_lib/bases/parts/baseinteractablepart.py,sha256=VXINrObIr6Y2tFIOI59cB_-625rPwtKZdGDmaa3EgQ8,574
 sm_blueprint_lib/bases/parts/baselogicpart.py,sha256=al9nLCg8YiLKWd_c_ZQmq9f6sazjF6RNbuGGbYROOps,498
 sm_blueprint_lib/bases/parts/basepart.py,sha256=hzJBcB4uol65THzEZEGq4d2N9SbK1S4XiMghEuB6cuc,1126
+sm_blueprint_lib/parts/__init__.py,sha256=3MW-wlhw2BepJ4bo1_xSAe2DzsfQ1yh-U3UnjWgZm2w,140
 sm_blueprint_lib/parts/barrierblock.py,sha256=GPI8ArKKvzO6wnHfBfgmU4Ezcrw9SmtKR0p4mWczYiw,267
 sm_blueprint_lib/parts/logicgate.py,sha256=In7-d-lCx1zJIT-7S0Mh7s32lj7xZ6wxObJMnKJKQQ4,960
 sm_blueprint_lib/parts/sensor.py,sha256=ZJY5xo0NB6wAwgzS7EO-xgsukXYbwV7ptbGOqLfeBKQ,1008
 sm_blueprint_lib/parts/switch.py,sha256=3Yo1xMKV5kWnptgnAA1XR_VU2ft-10EuKR62nzvZ0gI,225
 sm_blueprint_lib/parts/timer.py,sha256=gw9XaWvP2yW3egT72BGowMu-CZFUY-Hke-Dwg0lsxjM,806
+sm_blueprint_lib/prebuilds/__init__.py,sha256=iPrsPMiuoluIDvdLGuQmEJ-I11D5qk563ANKr3md1GM,337
 sm_blueprint_lib/prebuilds/adder.py,sha256=Rq-006N_oD5ExIwQelgfrBKd7g8zFVxk4tj2lZEp82w,1750
 sm_blueprint_lib/prebuilds/barrel_shifter.py,sha256=BOvsUg9o6YzVrclmGNzhSbt9eQL23GJHHVyNxkXbcaE,3556
 sm_blueprint_lib/prebuilds/clock40hz.py,sha256=ygG8ieqpFzGMnuY5CBTs60liAYyAsBx-YIlb0gl3SXM,844
@@ -32,7 +34,7 @@ sm_blueprint_lib/prebuilds/register.py,sha256=MAiplmiA2L_VJaxCX2E8QuancnoqvyLY-v
 sm_blueprint_lib/prebuilds/rom.py,sha256=4dxAaNxRX60kDW17NKew-TJkPB7EMfHuK_zVIm6N-jo,3700
 sm_blueprint_lib/prebuilds/timer_ram_cached.py,sha256=PG53hDKYS00fur5vazh7iOs2Gm4G_URJLX7d9xWJOe4,19057
 sm_blueprint_lib/prebuilds/timer_ram_multiclient.py,sha256=NlQeJB6ilEGJDrIOfkFmPWd7afDR_0CUZH7RQpjyA4s,4200
-sm_blueprint_lib-0.0.6.dist-info/METADATA,sha256=PuNO-nrz_OB8Iq0BGapU0yrouBhfC5d0bbkxfkv8yXM,611
-sm_blueprint_lib-0.0.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sm_blueprint_lib-0.0.6.dist-info/licenses/LICENSE,sha256=DWhaodryTSEv07KdWbanCMaEujOXYxnj-IEhmgTkOq0,1084
-sm_blueprint_lib-0.0.6.dist-info/RECORD,,
+sm_blueprint_lib-0.0.8.dist-info/METADATA,sha256=a8b9VUFkqtRqzOTuWkomOeOb6y6r7VerAgp7ZNuOGs0,3378
+sm_blueprint_lib-0.0.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sm_blueprint_lib-0.0.8.dist-info/licenses/LICENSE,sha256=DWhaodryTSEv07KdWbanCMaEujOXYxnj-IEhmgTkOq0,1084
+sm_blueprint_lib-0.0.8.dist-info/RECORD,,

sm_blueprint_lib-0.0.6.dist-info/METADATA

@@ -1,17 +0,0 @@
-Metadata-Version: 2.4
-Name: sm_blueprint_lib
-Version: 0.0.6
-Summary: Scrap Mechanic Library for Blueprint manipulation.
-Project-URL: Homepage, https://github.com/MauriceTZ/sm_blueprint_lib
-Project-URL: Issues, https://github.com/MauriceTZ/sm_blueprint_lib/issues
-Author-email: Maurice <mauriciotorrez00@gmail.com>
-License-Expression: MIT
-License-File: LICENSE
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.8
-Requires-Dist: numpy
-Description-Content-Type: text/markdown
-
-# sm_blueprint_lib
- Scrap Mechanic Library for Blueprint manipulation.