[Automated-testing] [PATCH] devauto python package structure and initial docstrings

[Benjamin Esquivel]

this is the layout of the devauto python package including the initial
docstrings. Further development will happen within the modules.

the devauto package initial documentation can be seen via standard
python docstrings. The 3 modules that will be initially developed
are created though the module layout and interfaces will come in a
future commit

Signed-off-by: Benjamin Esquivel <benjamin.esquivel at linux.intel.com>
---
 devauto/README.md          | 9 +++++++++
 devauto/__init__.py        | 7 +++++++
 devauto/kbemu/__init__.py  | 5 +++++
 devauto/rps/__init__.py    | 5 +++++
 devauto/usbmux/__init__.py | 5 +++++
 5 files changed, 31 insertions(+)
 create mode 100644 devauto/README.md
 create mode 100644 devauto/__init__.py
 create mode 100644 devauto/kbemu/__init__.py
 create mode 100644 devauto/rps/__init__.py
 create mode 100644 devauto/usbmux/__init__.py

diff --git a/devauto/README.md b/devauto/README.md
new file mode 100644
index 0000000..1693b3d
--- /dev/null
+++ b/devauto/README.md
@@ -0,0 +1,9 @@
+This is the device automation tree that stores code for the modules that
+manage the remote controllers. These controllers are used for automated
+tasks like testing through power cycles, emulating keyboard inputs and
+switching USB devices.
+
+This python package is documentated with docstrings. It means that you can
+import the module and call the help builtin:
+
+  $ python -c "import devauto; help(devauto)"
diff --git a/devauto/__init__.py b/devauto/__init__.py
new file mode 100644
index 0000000..f6d5030
--- /dev/null
+++ b/devauto/__init__.py
@@ -0,0 +1,7 @@
+"""A collection of device automation controller modules.
+
+This the device automation package that stores the modules that manage the
+remote device automation controllers. These controllers are used for task
+automation such as testing devices through power cycles, emulating keyboard
+inputs and switching USB resources to the devices.
+"""
diff --git a/devauto/kbemu/__init__.py b/devauto/kbemu/__init__.py
new file mode 100644
index 0000000..dceafd1
--- /dev/null
+++ b/devauto/kbemu/__init__.py
@@ -0,0 +1,5 @@
+"""A remote keyboard input emulator.
+
+Provides a library for sending keyboard inputs to a remote device. Inputs
+can be single keystrokes, key combinations or key sequences.
+"""
diff --git a/devauto/rps/__init__.py b/devauto/rps/__init__.py
new file mode 100644
index 0000000..a5ba3ee
--- /dev/null
+++ b/devauto/rps/__init__.py
@@ -0,0 +1,5 @@
+"""A network controlled power switch.
+
+Provides a library for controlling a remote power switch that is able to
+turn on and off the devices that it powers.
+"""
diff --git a/devauto/usbmux/__init__.py b/devauto/usbmux/__init__.py
new file mode 100644
index 0000000..c191b7c
--- /dev/null
+++ b/devauto/usbmux/__init__.py
@@ -0,0 +1,5 @@
+"""A remote USB multiplexer.
+
+Provides a library for multiplexing USB resources and make them available
+at the USB ports of the devices connected to the MUX.
+"""
-- 
2.5.5