PyObjectInterface 0.0.3__py3-none-any.whl → 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. PyObjectInterface/examples/example.py +8 -0
  2. PyObjectInterface/examples/robot.py +31 -0
  3. PyObjectInterface-0.1.0.dist-info/METADATA +79 -0
  4. PyObjectInterface-0.1.0.dist-info/RECORD +10 -0
  5. {PyObjectInterface-0.0.3.dist-info → PyObjectInterface-0.1.0.dist-info}/WHEEL +1 -1
  6. PyObjectInterface-0.0.3.dist-info/METADATA +0 -29
  7. PyObjectInterface-0.0.3.dist-info/RECORD +0 -8
  8. {PyObjectInterface-0.0.3.dist-info → PyObjectInterface-0.1.0.dist-info}/LICENSE +0 -0
  9. {PyObjectInterface-0.0.3.dist-info → PyObjectInterface-0.1.0.dist-info}/top_level.txt +0 -0
PyObjectInterface/examples/example.py ADDED
@@ -0,0 +1,8 @@
1
+ from PyObjectInterface.WebController import create_WebController
2
+ from robot import Robot
3
+ import flask
4
+
5
+ app = flask.Flask('Demo')
6
+ robot = Robot()
7
+ create_WebController(robot, 'robot', app)
8
+ app.run()
PyObjectInterface/examples/robot.py ADDED
@@ -0,0 +1,31 @@
1
+ class DriveMotor:
2
+ def __init__(self, pin):
3
+ self.pin = pin
4
+ self.speed = 0
5
+
6
+ def forward(self):
7
+ self.speed = 50
8
+
9
+ def stop(self):
10
+ self.speed = 0
11
+
12
+ class Robot:
13
+ def __init__(self):
14
+ self.left_motor = DriveMotor(1)
15
+ self.right_motor = DriveMotor(2)
16
+
17
+ def forward(self):
18
+ self.left_motor.forward()
19
+ self.right_motor.forward()
20
+
21
+ def stop(self):
22
+ self.left_motor.stop()
23
+ self.right_motor.stop()
24
+
25
+ def left(self):
26
+ self.left_motor.stop()
27
+ self.right_motor.forward()
28
+
29
+ def right(self):
30
+ self.left_motor.forward()
31
+ self.right_motor.stop()
PyObjectInterface-0.1.0.dist-info/METADATA ADDED
@@ -0,0 +1,79 @@
1
+ Metadata-Version: 2.1
2
+ Name: PyObjectInterface
3
+ Version: 0.1.0
4
+ Summary: Create a web interface to interact with a class
5
+ Home-page: https://github.com/RobertJN64/PyObjectInterface
6
+ Author: Robert Nies
7
+ Author-email: robertjnies@gmail.com
8
+ License: MIT
9
+ Classifier: Programming Language :: Python
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3 :: Only
12
+ Classifier: Programming Language :: Python :: 3.8
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Requires-Python: >=3.8
18
+ Description-Content-Type: text/markdown
19
+ License-File: LICENSE
20
+ Requires-Dist: typing-extensions
21
+ Requires-Dist: flask
22
+
23
+ # PyObjectInterface
24
+
25
+ ![Tests Badge](https://github.com/RobertJN64/PyObjectInterface/actions/workflows/tests.yml/badge.svg)
26
+ ![Python Version Badge](https://img.shields.io/pypi/pyversions/PyObjectInterface)
27
+ ![License Badge](https://img.shields.io/github/license/RobertJN64/PyObjectInterface)
28
+
29
+ Quickly control any python object through an async web interface.
30
+
31
+ `pip install PyObjectInterface`
32
+ ```python
33
+ from PyObjectInterface.WebController import create_WebController
34
+ import flask
35
+
36
+ app = flask.Flask('Demo')
37
+ any_python_object = ...
38
+ create_WebController(any_python_object, 'any_python_object', app)
39
+ app.run()
40
+ ```
41
+
42
+ Go to `http://127.0.0.1:5000/webcontroller`
43
+
44
+ ## Example: Async Robot Control
45
+ ![async_robot_control.png](async_robot_control.png)
46
+
47
+ The above interface was automatically created from:
48
+ ```python
49
+ class DriveMotor:
50
+ def __init__(self, pin):
51
+ self.pin = pin
52
+ self.speed = 0
53
+
54
+ def forward(self): ...
55
+ def stop(self): ...
56
+
57
+ class Robot:
58
+ def __init__(self):
59
+ self.left_motor = DriveMotor(1)
60
+ self.right_motor = DriveMotor(2)
61
+
62
+ def forward(self): ...
63
+ def stop(self): ...
64
+ def left(self): ...
65
+ def right(self): ...
66
+ ```
67
+
68
+ Look at [PyObjectInterface/examples/example.py](PyObjectInterface/examples/example.py) for more information.
69
+
70
+ ## Advanced Usage and Settings
71
+
72
+ You can use PyObjectInterface without the WebController.
73
+
74
+ ### create_WebController
75
+ - `obj`: Any python object
76
+ - `name: str`: Friendly name for object, generally the name of the variable that refers to the object
77
+ - `flask_app`: return value of flask.Flask()
78
+ - `recursion_depth = 5`: maximum layers of subobjects to include
79
+ - `create_private_interface = True`: if `True` creates a `/webcontroller/private` page that includes private methods and attributes
PyObjectInterface-0.1.0.dist-info/RECORD ADDED
@@ -0,0 +1,10 @@
1
+ PyObjectInterface/WebController.py,sha256=YMQSaugLIKEwDxHkPTGjD4zAuIjk4X0ANf_UxtbSAbU,3820
2
+ PyObjectInterface/__init__.py,sha256=4524Z5al5Bwx4EsmPW7UldGaexNUMGCv0cldb3uobuQ,3674
3
+ PyObjectInterface/web_controller.tpl.html,sha256=KiNOmUGwsyAmkV9yol2X15G6uoAPjf2JHa6tnoCe_kw,2432
4
+ PyObjectInterface/examples/example.py,sha256=QhAcJJnh6LU923TL7MHwYU5keur1hgfn7Elt5nh8c-E,196
5
+ PyObjectInterface/examples/robot.py,sha256=qvDhIwvCtseA0AlEdZbR7RJkpbOMMw0F1C3UWNMs--M,655
6
+ PyObjectInterface-0.1.0.dist-info/LICENSE,sha256=_UXYaTVmtWrJCpKEgCz66EUsoFfLfn0CY4mEmuI5_zA,1054
7
+ PyObjectInterface-0.1.0.dist-info/METADATA,sha256=qtK66t-YQGBfpofNpMDFhVWuMxhujmu64YFVYlRH7PY,2559
8
+ PyObjectInterface-0.1.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
9
+ PyObjectInterface-0.1.0.dist-info/top_level.txt,sha256=5kOSl8l5D5IGWoWz9nkn_lQispA3D8qyPM9SvIC4LSU,18
10
+ PyObjectInterface-0.1.0.dist-info/RECORD,,
{PyObjectInterface-0.0.3.dist-info → PyObjectInterface-0.1.0.dist-info}/WHEEL RENAMED
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: bdist_wheel (0.41.3)
2
+ Generator: bdist_wheel (0.42.0)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5
 
PyObjectInterface-0.0.3.dist-info/METADATA DELETED
@@ -1,29 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: PyObjectInterface
3
- Version: 0.0.3
4
- Summary: Create a web interface to interact with a class
5
- Home-page: https://github.com/RobertJN64/PyObjectInterface
6
- Author: Robert Nies
7
- Author-email: robertjnies@gmail.com
8
- License: MIT
9
- Classifier: Programming Language :: Python
10
- Classifier: Programming Language :: Python :: 3
11
- Classifier: Programming Language :: Python :: 3 :: Only
12
- Classifier: Programming Language :: Python :: 3.8
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Classifier: Programming Language :: Python :: 3.12
17
- Requires-Python: >=3.8
18
- Description-Content-Type: text/markdown
19
- License-File: LICENSE
20
- Requires-Dist: typing-extensions
21
- Requires-Dist: flask
22
-
23
- # PyObjectInterface
24
-
25
- ![Tests Badge](https://github.com/RobertJN64/PyObjectInterface/actions/workflows/tests.yml/badge.svg)
26
- ![Python Version Badge](https://img.shields.io/pypi/pyversions/PyObjectInterface)
27
- ![License Badge](https://img.shields.io/github/license/RobertJN64/PyObjectInterface)
28
-
29
- `#TODO - good desc`
PyObjectInterface-0.0.3.dist-info/RECORD DELETED
@@ -1,8 +0,0 @@
1
- PyObjectInterface/WebController.py,sha256=YMQSaugLIKEwDxHkPTGjD4zAuIjk4X0ANf_UxtbSAbU,3820
2
- PyObjectInterface/__init__.py,sha256=4524Z5al5Bwx4EsmPW7UldGaexNUMGCv0cldb3uobuQ,3674
3
- PyObjectInterface/web_controller.tpl.html,sha256=KiNOmUGwsyAmkV9yol2X15G6uoAPjf2JHa6tnoCe_kw,2432
4
- PyObjectInterface-0.0.3.dist-info/LICENSE,sha256=_UXYaTVmtWrJCpKEgCz66EUsoFfLfn0CY4mEmuI5_zA,1054
5
- PyObjectInterface-0.0.3.dist-info/METADATA,sha256=5j1nSt8GC9VMEGgP3kSbzstQuGkaDBBHGudro4YMXNI,1097
6
- PyObjectInterface-0.0.3.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
7
- PyObjectInterface-0.0.3.dist-info/top_level.txt,sha256=5kOSl8l5D5IGWoWz9nkn_lQispA3D8qyPM9SvIC4LSU,18
8
- PyObjectInterface-0.0.3.dist-info/RECORD,,