pyalamake 0.0.1__tar.gz

pyalamake-0.0.1/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) since 2024: pyalamake Module
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyalamake-0.0.1/MANIFEST.in

@@ -0,0 +1,2 @@
+graft pyalamake
+global-exclude *.py[cod]

pyalamake-0.0.1/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.1
+Name: pyalamake
+Version: 0.0.1
+Summary: Base Class for $module-name$
+Home-page: https://bitbucket.org/arrizza-public/pyalamake/src/master
+Download-URL: https://bitbucket.org/arrizza-public/pyalamake/get/master.zip
+Author: JA
+Author-email: cppgent0@gmail.com
+License: MIT
+Keywords: gui,test,verification
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Utilities
+Classifier: Programming Language :: Python :: 3.9
+Classifier: License :: OSI Approved :: MIT License
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: medver-pytest
+Requires-Dist: pytest
+
+website: <https://arrizza.com/python-alamake>
+
+## Summary
+
+This Python module generates a multi-target Makefile for cross-platform projects all of which is compatible with JetBrain's Clion IDE.
+
+For example, see gen.py for a Python script (gen.py) that generates:
+
+* two Arduino projects and an Arduino core for them
+* a GTest project to run UTs against an Arduino Project
+* a C/++ project
+
+all into one Makefile, and all recognized by CLion.
+
+See also gen_3cores.py that shows how to build 3 Arduino on 3 different boards in the same project and same Makefile.
+
+## Why not CMake?
+
+I use JetBrain's CLion. Ut can handle only a CMake or Makefile based project.
+
+Also, I like to use GTest to UT my Arduino projects (if possible). But CMake can't handle a project that uses
+two compilers i.e. avr-gcc for Arduino and gcc for GTest. It tried some different CMake techniques
+to allow that but they either didn't work or CLion still didn't recognize the components being used.
+
+The only option then was to use Python to generate a Makefile that CLion was compatible with.
+
+## Why not ninja instead of make?
+
+Because CLion can't use that to self-configure. CMake in CLion can be configured to use
+Ninja, but the IDE uses CMake to configure itself for the project. Therefore, Makefile.
+
+## Why?
+
+Currently, I have relatively simple projects using one Arduino and some GTest UTs. But I do have some
+projects that could use multiple Arduino's communicating with each other. And possibly some other
+microcontrollers e.g. STM32, ESP32, etc. that communicate with Arduino's or themselves.
+
+CLion can't handle that.
+
+But (finger crossed) I should be able to extend pyalamake to build STM32 and ESP32 targets relatively easily, still allow
+GTests for those microcontrollers, etc.
+
+## How to use
+
+```bash
+./gen.py    # to generate/update the Makefile
+
+make help   # to show the list of makefile targets
+
+make                # build all targets: Arduino core, both blink targets, GTest UT, and sample C++ app
+
+make blink-upload   # upload the blink app to an Arduino; 
+                    # should blink random times (2 - 15) and random rate (0 - 255ms);
+make blink2-upload  # upload the blink2 app to an Arduino;
+                    # should blink 2 times
+make core           # build the Arduino Core
+
+make ut-run         # run the GTEST unit tests
+make ut-cov         # show the source code coverage of the GTEST UTs
+                    # open debug/ut.html in a browser for a gcov HTML report
+
+make hello-run            # run C++ hello world app
+make hello-run s="john"   # to pass a CLI args to hello world 
+
+make clean         # clean all
+make <tgt>-clean   # clean a specific target
+```
+
+## updating gen.py
+
+```python
+from pyalamake.lib.pyalamake import alamake
+
+# specify all components to be added to the makefile
+# ... skip see below ...
+
+# === generate makefile for all targets
+alamake.makefile()
+
+```
+
+At this point, the Makefile should contain all targets specified
+
+#### Arduino targets
+
+Creating an Arduino .hex requires 3 steps:
+
+1) gen an Arduino Shared component
+    * holds common, shared information like boardid, serial port, etc.
+2) gen an Arduino Core
+    * use the same shared component created above
+    * holds the Arduino Core library compiled for the same boardid, etc.
+3) gen the Arduino App
+    * use the same shared component created above
+    * holds the Arduino app compiled for the same boardid etc.
+
+A shared component and core can be used with multiple Arduino targets.
+
+Example generation of an Arduino shared component:
+
+```python
+sh1 = alamake.create_arduino_shared()
+sh1.set_boardid('nano-atmega328old')
+# sh1.set_boardid('uno')
+# sh1.set_boardid('megaadk')
+
+# on Ubuntu, different boards use different serial ports 
+if sh1.boardid in ['uno', 'megaadk']:
+    sh1.set_avrdude_port('/dev/ttyACM0')
+else:
+    sh1.set_avrdude_port('/dev/ttyUSB0')
+
+# at this point sh1 is only missing core related settings
+```
+
+Example generation of an Arduino core:
+
+```python
+# share the same component created above
+core = alamake.create('core', 'arduino-core', shared=sh1)
+# no additional directories, libs, etc. needed
+core.check()
+```
+
+Example generation of an Arduino target:
+
+```python
+# share the same component created above
+blink = alamake.create('blink', 'arduino', shared=sh1)
+blink.add_sources([
+    'src/blink.cpp',
+    'src/common.cpp',
+])
+blink.add_include_directories(['src'])
+```
+
+#### GTest target
+
+Example generation of a GTest target that tests an Arduino app
+
+```python
+ut = alamake.create('ut', 'gtest')
+
+# tests the blink2.cpp (Arduino) in src2 directory
+ut.add_include_directories([
+    'src2',
+    'ut/mock_arduino',
+])
+
+# uses a Mock Arduino libary to check blink2 behavior
+ut.add_sources([
+    'ut/mock_arduino/mock_arduino.cpp',
+    'ut/ut_test1.cpp',
+])
+
+# specify the directory(s) that should be part of the coverage report
+ut.add_coverage(['src2'])
+
+```
+
+#### C++ targets
+
+Example generation of a C++ target
+
+```python
+hello = alamake.create('hello', 'cpp')
+hello.add_include_directories(['src'])
+hello.add_sources([
+    'src/hello.cpp',
+])
+```
+
+## Limitations
+
+* works only on Ubuntu. There will likely be additional work needed for macOS and Windows.
+* Arduino libraries can not be added to a target.
+* See todo.md for more work to be done.
+* tested with an Arduino Nano (boardid: nano-atmega328old), Arduino MegaADK (boardid: megaadk) and Arduino Uno (boardid: uno).
+  Other boards should work correctly, but there is always a possibility it fails.
+* I have not tested using an Arduino programmer
+* I have not tested an app that requires Arduino EEPROM uploads.
+

pyalamake-0.0.1/README.md

@@ -0,0 +1,182 @@
+website: <https://arrizza.com/python-alamake>
+
+## Summary
+
+This Python module generates a multi-target Makefile for cross-platform projects all of which is compatible with JetBrain's Clion IDE.
+
+For example, see gen.py for a Python script (gen.py) that generates:
+
+* two Arduino projects and an Arduino core for them
+* a GTest project to run UTs against an Arduino Project
+* a C/++ project
+
+all into one Makefile, and all recognized by CLion.
+
+See also gen_3cores.py that shows how to build 3 Arduino on 3 different boards in the same project and same Makefile.
+
+## Why not CMake?
+
+I use JetBrain's CLion. Ut can handle only a CMake or Makefile based project.
+
+Also, I like to use GTest to UT my Arduino projects (if possible). But CMake can't handle a project that uses
+two compilers i.e. avr-gcc for Arduino and gcc for GTest. It tried some different CMake techniques
+to allow that but they either didn't work or CLion still didn't recognize the components being used.
+
+The only option then was to use Python to generate a Makefile that CLion was compatible with.
+
+## Why not ninja instead of make?
+
+Because CLion can't use that to self-configure. CMake in CLion can be configured to use
+Ninja, but the IDE uses CMake to configure itself for the project. Therefore, Makefile.
+
+## Why?
+
+Currently, I have relatively simple projects using one Arduino and some GTest UTs. But I do have some
+projects that could use multiple Arduino's communicating with each other. And possibly some other
+microcontrollers e.g. STM32, ESP32, etc. that communicate with Arduino's or themselves.
+
+CLion can't handle that.
+
+But (finger crossed) I should be able to extend pyalamake to build STM32 and ESP32 targets relatively easily, still allow
+GTests for those microcontrollers, etc.
+
+## How to use
+
+```bash
+./gen.py    # to generate/update the Makefile
+
+make help   # to show the list of makefile targets
+
+make                # build all targets: Arduino core, both blink targets, GTest UT, and sample C++ app
+
+make blink-upload   # upload the blink app to an Arduino; 
+                    # should blink random times (2 - 15) and random rate (0 - 255ms);
+make blink2-upload  # upload the blink2 app to an Arduino;
+                    # should blink 2 times
+make core           # build the Arduino Core
+
+make ut-run         # run the GTEST unit tests
+make ut-cov         # show the source code coverage of the GTEST UTs
+                    # open debug/ut.html in a browser for a gcov HTML report
+
+make hello-run            # run C++ hello world app
+make hello-run s="john"   # to pass a CLI args to hello world 
+
+make clean         # clean all
+make <tgt>-clean   # clean a specific target
+```
+
+## updating gen.py
+
+```python
+from pyalamake.lib.pyalamake import alamake
+
+# specify all components to be added to the makefile
+# ... skip see below ...
+
+# === generate makefile for all targets
+alamake.makefile()
+
+```
+
+At this point, the Makefile should contain all targets specified
+
+#### Arduino targets
+
+Creating an Arduino .hex requires 3 steps:
+
+1) gen an Arduino Shared component
+    * holds common, shared information like boardid, serial port, etc.
+2) gen an Arduino Core
+    * use the same shared component created above
+    * holds the Arduino Core library compiled for the same boardid, etc.
+3) gen the Arduino App
+    * use the same shared component created above
+    * holds the Arduino app compiled for the same boardid etc.
+
+A shared component and core can be used with multiple Arduino targets.
+
+Example generation of an Arduino shared component:
+
+```python
+sh1 = alamake.create_arduino_shared()
+sh1.set_boardid('nano-atmega328old')
+# sh1.set_boardid('uno')
+# sh1.set_boardid('megaadk')
+
+# on Ubuntu, different boards use different serial ports 
+if sh1.boardid in ['uno', 'megaadk']:
+    sh1.set_avrdude_port('/dev/ttyACM0')
+else:
+    sh1.set_avrdude_port('/dev/ttyUSB0')
+
+# at this point sh1 is only missing core related settings
+```
+
+Example generation of an Arduino core:
+
+```python
+# share the same component created above
+core = alamake.create('core', 'arduino-core', shared=sh1)
+# no additional directories, libs, etc. needed
+core.check()
+```
+
+Example generation of an Arduino target:
+
+```python
+# share the same component created above
+blink = alamake.create('blink', 'arduino', shared=sh1)
+blink.add_sources([
+    'src/blink.cpp',
+    'src/common.cpp',
+])
+blink.add_include_directories(['src'])
+```
+
+#### GTest target
+
+Example generation of a GTest target that tests an Arduino app
+
+```python
+ut = alamake.create('ut', 'gtest')
+
+# tests the blink2.cpp (Arduino) in src2 directory
+ut.add_include_directories([
+    'src2',
+    'ut/mock_arduino',
+])
+
+# uses a Mock Arduino libary to check blink2 behavior
+ut.add_sources([
+    'ut/mock_arduino/mock_arduino.cpp',
+    'ut/ut_test1.cpp',
+])
+
+# specify the directory(s) that should be part of the coverage report
+ut.add_coverage(['src2'])
+
+```
+
+#### C++ targets
+
+Example generation of a C++ target
+
+```python
+hello = alamake.create('hello', 'cpp')
+hello.add_include_directories(['src'])
+hello.add_sources([
+    'src/hello.cpp',
+])
+```
+
+## Limitations
+
+* works only on Ubuntu. There will likely be additional work needed for macOS and Windows.
+* Arduino libraries can not be added to a target.
+* See todo.md for more work to be done.
+* tested with an Arduino Nano (boardid: nano-atmega328old), Arduino MegaADK (boardid: megaadk) and Arduino Uno (boardid: uno).
+  Other boards should work correctly, but there is always a possibility it fails.
+* I have not tested using an Arduino programmer
+* I have not tested an app that requires Arduino EEPROM uploads.
+

pyalamake-0.0.1/pyalamake/lib/.gitignore

@@ -0,0 +1,2 @@
+/build_info.py
+/version.json

pyalamake-0.0.1/pyalamake/lib/arduino_shared.py

@@ -0,0 +1,114 @@
+import json
+import os
+
+from .svc import svc
+
+
+# --------------------
+class ArduinoShared:
+    # set by user
+    boardid = None
+    avrdude_port = None
+
+    # these are from /usr/share/arduino/hardware/arduino/avr/boards.txt
+    f_cpu = None
+    mcu = None
+    avrdude = None
+    avrdude_baudrate = None
+    avrdude_protocol = None
+    # these are derived from the above
+    common_flags = None
+    cpp_flags = None
+    cc_flags = None
+
+    arduino_dir = '/usr/share/arduino'
+    cpp = 'avr-g++'
+    cc = 'avr-gcc'
+    ar = 'avr-ar'
+    obj_copy = 'avr-objcopy'
+    avrdude_dir = '/usr/share/arduino/hardware/tools'
+
+    # core related
+    core_tgt = None  # name of core target
+    corelib = None  # path to core lib
+    corelib_name = None  # name of the lib
+    coredir = None  # the build dir
+    core_includes = [
+        f'{arduino_dir}/hardware/arduino/avr/cores/arduino',
+        f'{arduino_dir}/hardware/arduino/avr/variants/standard',
+    ]
+
+    # --------------------
+    def set_avrdude_port(self, val):
+        self.avrdude_port = val
+
+    # --------------------
+    def print_board_list(self):
+        boards = self._get_board_json()
+        svc.log.line('Available boards:')
+        for name, info in boards.items():
+            svc.log.line(f'   {name: <20}: {info["fullname"]}')
+
+    # --------------------
+    def check(self):
+        errs = 0
+        errs = self._check_arg(errs, 'boardid')
+        errs = self._check_arg(errs, 'avrdude_port')
+        errs = self._check_arg(errs, 'f_cpu')
+        errs = self._check_arg(errs, 'mcu')
+        errs = self._check_arg(errs, 'avrdude')
+        errs = self._check_arg(errs, 'avrdude_baudrate')
+        errs = self._check_arg(errs, 'avrdude_protocol')
+        errs = self._check_arg(errs, 'common_flags')
+        errs = self._check_arg(errs, 'cpp_flags')
+        errs = self._check_arg(errs, 'cc_flags')
+
+        errs = self._check_arg(errs, 'core_tgt')
+        errs = self._check_arg(errs, 'coredir')
+        errs = self._check_arg(errs, 'corelib')
+        errs = self._check_arg(errs, 'corelib_name')
+
+        if errs > 0:
+            svc.abort('arduino: resolve errors')
+
+    # --------------------
+    def _check_arg(self, errs, arg):
+        selfarg = getattr(self, arg, None)
+        if selfarg is None:
+            errs += 1
+            svc.log.err(f'arduino: {arg} is not set')
+        return errs
+
+    # --------------------
+    def set_boardid(self, boardid):
+        info = self._get_board_info(boardid)
+        self.boardid = boardid
+
+        # set values based on board id
+        self.f_cpu = info['build.f_cpu']
+        self.mcu = info['build.mcu']
+        self.avrdude = info['upload.tool']
+        self.avrdude_baudrate = info['upload.speed']
+        self.avrdude_protocol = info['upload.protocol']
+
+        self.common_flags = f'-c -g -Os -Wall -ffunction-sections -fdata-sections ' \
+                            f'-mmcu={self.mcu} -DF_CPU={self.f_cpu}L ' \
+                            '-MMD -DUSB_VID=null -DUSB_PID=null -DARDUINO=106'
+        self.cpp_flags = f'{self.common_flags} -fno-exceptions -std=c++11'
+        self.cc_flags = self.common_flags
+
+    # --------------------
+    def _get_board_info(self, boardid):
+        boards = self._get_board_json()
+        if boardid not in boards:
+            svc.abort(f'ardunio: invalid boardid: {boardid}')
+
+        info = boards[boardid]
+        return info
+
+    # --------------------
+    def _get_board_json(self):
+        path = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'boards.json')
+        with open(path, 'r', encoding='utf-8') as fp:
+            boards = json.load(fp)
+            return boards