prototype: Initial barebones prototype
This implements a bare-bones mdt command that can be used as a pip package and
installed on a host system. Currently it implements a bare skeleton for command
line processing and also handles mDNS discovery of specific devices advertising
the "_google._mdt._tcp" service.
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..bee8a64
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+__pycache__
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..b046241
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,205 @@
+All code in the docs, build and board repositories are covered under the Apache
+license. Other repositories have their own licenses as indicated in the
+repository.
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/MANIFEST.in
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f5fe028
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+MDT - The Mendel Development Tool
+=================================
+
+## What is this?
+
+MDT is a simple tool to aid in working with single board computers that the
+Mendel Linux distribution runs on. It consists of a whole bunch of pre-existing
+open source tooling, coupled with some simple wrappers written in python to ease
+their use.
+
+It also provides an easy way to interact with these boards without having to
+fight with serial consoles, IP addresses, and other fiddly bits, reducing
+barrier to entry when working with these boards.
+
+With minimal effort, MDT should also be portable to existing systems such as
+Debian and Ubuntu, if needed. This, however, is out of the scope of this
+project.
diff --git a/mdt/__init__.py b/mdt/__init__.py
new file mode 100755
index 0000000..e69de29
--- /dev/null
+++ b/mdt/__init__.py
diff --git a/mdt/devices.py b/mdt/devices.py
new file mode 100644
index 0000000..459cf5a
--- /dev/null
+++ b/mdt/devices.py
@@ -0,0 +1,14 @@
+from time import sleep
+
+from discoverer import Discoverer
+
+class DevicesCommand:
+ def __init__(self):
+ self.discoverer = Discoverer()
+
+ def run(self, args):
+ sleep(1)
+ print('Devices found:')
+ discoveries = self.discoverer.discoveries
+ for host, address in discoveries.items():
+ print('%s\t\t%s' % (host, address))
diff --git a/mdt/discoverer.py b/mdt/discoverer.py
new file mode 100644
index 0000000..d09f665
--- /dev/null
+++ b/mdt/discoverer.py
@@ -0,0 +1,19 @@
+from typing import cast
+from zeroconf import ServiceBrowser, Zeroconf
+
+class Discoverer:
+ def __init__(self):
+ self.zeroconf = Zeroconf()
+ self.discoveries = {}
+ browser = ServiceBrowser(self.zeroconf, "_google_mdt._tcp.local.", self)
+
+ def add_service(self, zeroconf, type, name):
+ info = self.zeroconf.get_service_info(type, name)
+ if info:
+ hostname = info.server.split('.')[0]
+ address = socket.inet_ntoa(cast(bytes, info.address))
+ self.discoveries[hostname] = address
+
+ def remove_service(self, zeroconf, type, name):
+ info = self.zeroconf.get_service_info(type, name)
+ del(self.discoveries[info.server])
diff --git a/mdt/mdt.py b/mdt/mdt.py
new file mode 100755
index 0000000..5e3c8bd
--- /dev/null
+++ b/mdt/mdt.py
@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+
+"""MDT - The Mendel Development Tool
+
+This is the main CLI dispatch routine that teases out the command line and runs
+the appropriate command.
+"""
+
+import socket
+import sys
+
+import devices
+
+
+class HelpCommand:
+ def run(self, args):
+ print('implement me')
+
+
+COMMANDS = {
+ 'help': HelpCommand(),
+ 'devices': devices.DevicesCommand(),
+}
+
+
+def main():
+ if len(sys.argv) <= 1:
+ command = 'help'
+ else:
+ command = sys.argv[1].lower()
+
+ command = COMMANDS.get(command)
+ if command != None:
+ exit(command.run(sys.argv[1:]))
+
+
+if __name__ == '__main__':
+ main()
diff --git a/setup.py b/setup.py
new file mode 100755
index 0000000..7ef364d
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,46 @@
+from setuptools import setup, find_packages
+from os import path
+from io import open
+
+here = path.abspath(path.dirname(__file__))
+
+with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+ long_description = f.read()
+
+setup(
+ name='mdt',
+ version='1.0',
+ description='A command-line tool to manage Mendel embedded systems',
+ long_description=long_description,
+ long_description_content_type='text/markdown',
+ url='https://aiyprojects.googlesource.com/mdt.git',
+ author='Mendel Linux Software Team',
+ author_email='support-aiyprojects@google.com',
+ classifiers = [
+ # 3 -> Alpha
+ # 4 -> Beta
+ # 5 -> Production/Stable
+ 'Development Status :: 3 - Alpha',
+
+ 'Intended Audience :: Developers',
+ 'Topic :: Software Development',
+
+ 'License :: OSI Approved :: Apache License',
+
+ 'Programming Language :: Python :: 3',
+ ],
+ keywords='embedded development',
+ packages=find_packages(exclude=['contrib', 'docs', 'tests']),
+ install_requires=[
+ 'zeroconf',
+ 'paramiko'
+ ],
+ package_data={
+ 'default_mendel_ssh_key', [ 'data/mendel_ssh_id', 'data/mendel_ssh_id.pub' ],
+ },
+ entry_points={
+ 'console_script': [
+ 'mdt=mdt:main',
+ ],
+ },
+)
