pypi

Prepare repository for pip upload

Author: grimar2008

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include automatabpp *.py

README.md

@@ -26,7 +26,7 @@ Each graph is called a machine, and each execution is called a state. (Yes, ther
 
 To get a better idea of what's going on here's a quick example. Using a [__yEd Graph Editor__][4] Create a .graphml graph like this one and store it in the _graphs/_ folder of your project as _first.graphml_ .
 
-![](./README/images/first.png)
+![](./docs/images/first.png)
 
 Run the next code: (don't forget to clone the repository into your project folder)
 
@@ -87,20 +87,20 @@ I also recommend using **Python 3.4+** although I haven't even tried it yet on t
 
 ### Directories
 
-* **./automatabpp** - our module source code. This directory contains the python code for this project.
-* **./graphs** - yEd graphs are stored in this directory by default
-* **./README** - I've really took my time to write all of this so I would appreciate you checking it out
+* **./automatabpp/** - our module source code. This directory contains the python code for this project.
+* **./docs/** - I've really took my time to write all of this so I would appreciate you checking it out
+* **./graphs/** - yEd graphs are stored in this directory by default
 
 ### Additional Links
 
 Here are some other .md links for You to read about this project.
-* [A list of available functions](README/FSM.md)
-* [Tutorial](README/tutorial.md) - make a _"Hello, World!"_ type of application (sort of). Also some more insight on what happens in the code itself.
-* [Example 1](README/examples/example1.md) - a simple e-mail validation machine
-* [Example 2](README/examples/example2.md) - an example for developing with multiple machines
-* [Example 3](README/examples/example3.md) - an example showcasing Base64 encode with this paradigm
-* [Example 4](README/examples/example4.md) - developing your embedded application with _complex_ behaviour
-* [Other](README/other.md)
+* [A list of available functions](docs/FSM.md)
+* [Tutorial](docs/tutorial.md) - make a _"Hello, World!"_ type of application (sort of). Also some more insight on what happens in the code itself.
+* [Example 1](docs/examples/example1.md) - a simple e-mail validation machine
+* [Example 2](docs/examples/example2.md) - an example for developing with multiple machines
+* [Example 3](docs/examples/example3.md) - an example showcasing Base64 encode with this paradigm
+* [Example 4](docs/examples/example4.md) - developing your embedded application with _complex_ behaviour
+* [Other](docs/other.md)
 
 
 [1]: https://en.wikipedia.org/wiki/Automata-based_programming "Automata-based programming"

automatabpp/__init__.py

@@ -1,79 +1,5 @@
-__all__ = ["BEHAVIOUR", "EXECUTION", "OPERATION", "INTERFACE", "COMPARISONS"]
+from automatabpp.automatabpp import *
 
-import logging
-automata_bpp_logger = logging.getLogger(__name__)
-
-from . machines.machines import Machines
-from . xml.xmlread import read_graphml
-from . commandqueue.commandqueue import CommandQueue
-from . constants import GRAPHS_DIRECTORY, START_COMMAND_NAME, STOP_COMMAND_NAME
-from . comparisons.comparisons import COMPARISONS
-
-from functools import wraps
+__version__ = "1.0.0"
 
 __doc__ = """ docfile """
-
-
-class BEHAVIOUR:
-
-    @staticmethod
-    def set_default_graph_directory(new_path: str):
-        global GRAPHS_DIRECTORY
-        GRAPHS_DIRECTORY = new_path
-
-    @staticmethod
-    def load_behaviour_from_graph(graph_file_path: str, machine_name: str):
-        if graph_file_path[-8:] == ".graphml":
-            read_graphml("{}/{}".format(GRAPHS_DIRECTORY, graph_file_path), machine_name)
-        else:
-            automata_bpp_logger.warning("Unknown format for reading the graph file: {}".format(graph_file_path))
-
-
-class EXECUTION:
-
-    @staticmethod
-    def state(func):
-        current_machine = Machines().GetCurrentDefinedMachine()
-        if current_machine is not None:
-            current_machine.SetExecuteStateFunction(func.__name__, func)
-        return func
-
-
-class OPERATION:
-
-    @staticmethod
-    def start_fsm():
-        Machines().ExecuteCommand(START_COMMAND_NAME)
-
-    @staticmethod
-    def stop_fsm():
-        Machines().ExecuteCommand(STOP_COMMAND_NAME)
-        Machines().ReturnToStart()
-        CommandQueue().EmptyAllCommands()
-
-    @staticmethod
-    def reset_fsm():
-        OPERATION.stop_fsm()
-        OPERATION.start_fsm()
-
-    @staticmethod
-    def run_fsm(cmd=None):
-        if cmd is None:
-            Machines().ExecuteAllCommands()
-        else:
-            Machines().ExecuteCommand(cmd)
-
-
-class INTERFACE:
-
-    @staticmethod
-    def run_command_if_lambda_on_result_true(lambda_func: callable, command: str):
-        def wrapper_out(func):
-            @wraps(func)
-            def wrapper_in(*args, **kwargs):
-                result = func(*args, **kwargs)
-                if lambda_func(result):
-                    Machines().ExecuteCommand(command)
-                return result
-            return wrapper_in
-        return wrapper_out

automatabpp/automatabpp.py

@@ -0,0 +1,77 @@
+__all__ = ["BEHAVIOUR", "EXECUTION", "OPERATION", "INTERFACE", "COMPARISONS"]
+
+import logging
+automata_bpp_logger = logging.getLogger(__name__)
+
+from . machines.machines import Machines
+from . xml.xmlread import read_graphml
+from . commandqueue.commandqueue import CommandQueue
+from . constants import GRAPHS_DIRECTORY, START_COMMAND_NAME, STOP_COMMAND_NAME
+from . comparisons.comparisons import COMPARISONS
+
+from functools import wraps
+
+
+class BEHAVIOUR:
+
+    @staticmethod
+    def set_default_graph_directory(new_path: str):
+        global GRAPHS_DIRECTORY
+        GRAPHS_DIRECTORY = new_path
+
+    @staticmethod
+    def load_behaviour_from_graph(graph_file_path: str, machine_name: str):
+        if graph_file_path[-8:] == ".graphml":
+            read_graphml("{}/{}".format(GRAPHS_DIRECTORY, graph_file_path), machine_name)
+        else:
+            automata_bpp_logger.warning("Unknown format for reading the graph file: {}".format(graph_file_path))
+
+
+class EXECUTION:
+
+    @staticmethod
+    def state(func):
+        current_machine = Machines().GetCurrentDefinedMachine()
+        if current_machine is not None:
+            current_machine.SetExecuteStateFunction(func.__name__, func)
+        return func
+
+
+class OPERATION:
+
+    @staticmethod
+    def start_fsm():
+        Machines().ExecuteCommand(START_COMMAND_NAME)
+
+    @staticmethod
+    def stop_fsm():
+        Machines().ExecuteCommand(STOP_COMMAND_NAME)
+        Machines().ReturnToStart()
+        CommandQueue().EmptyAllCommands()
+
+    @staticmethod
+    def reset_fsm():
+        OPERATION.stop_fsm()
+        OPERATION.start_fsm()
+
+    @staticmethod
+    def run_fsm(cmd=None):
+        if cmd is None:
+            Machines().ExecuteAllCommands()
+        else:
+            Machines().ExecuteCommand(cmd)
+
+
+class INTERFACE:
+
+    @staticmethod
+    def run_command_if_lambda_on_result_true(lambda_func: callable, command: str):
+        def wrapper_out(func):
+            @wraps(func)
+            def wrapper_in(*args, **kwargs):
+                result = func(*args, **kwargs)
+                if lambda_func(result):
+                    Machines().ExecuteCommand(command)
+                return result
+            return wrapper_in
+        return wrapper_out

automatabpp/commandqueue/commandqueue.py

@@ -1,4 +1,4 @@
-from automatabpp import automata_bpp_logger
+from automatabpp.automatabpp import automata_bpp_logger
 from automatabpp.metaclasses.singleton import Singleton
 
 

automatabpp/machine/machine.py

@@ -1,4 +1,4 @@
-from automatabpp import automata_bpp_logger
+from automatabpp.automatabpp import automata_bpp_logger
 from automatabpp.state.state import State
 from automatabpp.constants import START_STATE_NAME
 

automatabpp/machines/machines.py

@@ -1,4 +1,4 @@
-from automatabpp import automata_bpp_logger
+from automatabpp.automatabpp import automata_bpp_logger
 from automatabpp.metaclasses.singleton import Singleton
 from automatabpp.machine.machine import Machine
 from automatabpp.commandqueue.commandqueue import CommandQueue

automatabpp/state/state.py

@@ -1,4 +1,4 @@
-from automatabpp import automata_bpp_logger
+from automatabpp.automatabpp import automata_bpp_logger
 from automatabpp.commandqueue.commandqueue import CommandQueue