Support Python3 + cleanups and fixes

.flake8

@@ -0,0 +1,25 @@
+[flake8]
+max-line-length = 98
+max-doc-length = 78
+exclude =
+	.git,
+	.idea,
+	__pycache__,
+	build,
+	dist,
+	*.egg-info
+
+# be compatible to black
+# Missing trailing comma
+# Whitespace before ':'
+# line break before binary operator
+ignore =
+	C812,
+	E203,
+    W503,
+
+# Missing docstring in public function
+# .next() is not a thing in Python 3
+per-file-ignores =
+	tests/*:D103,
+	stm32loader/bootloader.py:B305,

.github/workflows/lint.yaml

@@ -0,0 +1,61 @@
+name: Lint
+
+on:
+  - push
+  - pull_request
+
+defaults:
+    run:
+        shell: bash
+
+jobs:
+    black:
+        strategy:
+            matrix:
+                os:
+                    - ubuntu-latest
+                python-version:
+                    - "3.11"
+        runs-on: ${{ matrix.os }}
+        steps:
+          - uses: actions/checkout@v2
+          - uses: psf/black@stable
+            with:
+                options: "--check --verbose"
+                src: "./stm32loader"
+    flake8:
+        strategy:
+            fail-fast: true
+            matrix:
+                os:
+                    - ubuntu-latest
+                python-version:
+                    - "3.11"
+        runs-on: ${{ matrix.os }}
+        steps:
+          - uses: actions/checkout@v2
+          - uses: actions/setup-python@v2
+            with:
+                python-version: ${{ matrix.python-version }}
+          - name: Install lint dependencies
+            run: pip install flake8 pyserial intelhex
+          - name: Run flake8
+            run: flake8 stm32loader
+    pylint:
+        strategy:
+            fail-fast: true
+            matrix:
+                os:
+                    - ubuntu-latest
+                python-version:
+                    - "3.11"
+        runs-on: ${{ matrix.os }}
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-python@v2
+              with:
+                  python-version: ${{ matrix.python-version }}
+            - name: Install lint dependencies
+              run: pip install pylint pyserial intelhex
+            - name: Run pylint
+              run: pylint stm32loader

.github/workflows/test.yaml

@@ -0,0 +1,33 @@
+name: Test
+
+on:
+    - push
+    - pull_request
+
+defaults:
+    run:
+        shell: bash
+
+jobs:
+    pytest:
+        strategy:
+            fail-fast: true
+            matrix:
+                os:
+                    - ubuntu-latest
+                    - windows-latest
+                python-version:
+                    - "3.9"
+                    - "3.10"
+                    - "3.11"
+                    - "pypy-3.9"
+        runs-on: ${{ matrix.os }}
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-python@v2
+              with:
+                  python-version: ${{ matrix.python-version }}
+            - name: Install test dependencies
+              run: pip install tox tox-gh-actions pyserial pytest intelhex
+            - name: Run setup and tests as defined in tox.ini
+              run: tox

.gitignore

@@ -0,0 +1,8 @@
+build/
+dist/
+*.egg-info/
+.tox/
+
+__pycache__/
+*.py[cod]
+.nox/

.pylintrc

@@ -0,0 +1,16 @@
+[FORMAT]
+max-line-length=98
+
+[MESSAGES CONTROL]
+disable=
+    fixme,                    # TO DOs are not errors.
+    consider-using-f-string,  # We're not on Python >= 3.6 yet.
+
+[REPORT]
+score=no
+
+[BASIC]
+good-names=
+    i,
+    e,
+    namespace,

.travis.yml

@@ -0,0 +1,32 @@
+language: python
+
+matrix:
+  include:
+    # Lint using nox on native Python 3.6
+    - python: "3.6"
+      env: NOXSESSION="lint"
+
+    # Test using nox on native Python 3.5/3.6/3.7/3.8
+    - python: "3.5"
+      env: NOXSESSION="tests-3.5"
+    - python: "3.6"
+      env: NOXSESSION="tests-3.6"
+    - python: "3.7"
+      env: NOXSESSION="tests-3.7"
+      dist: xenial  # necessary for Python 3.7
+      sudo: required  # necessary for Python 3.7
+    - python: "3.8"
+      env: NOXSESSION="tests-3.8"
+      dist: xenial  # necessary for Python 3.8
+      sudo: required  # necessary for Python 3.8?
+
+    # Test using nox on non-native Python version 3.6
+    # (nox does not natively run on 3.4)
+    - python: "3.6"
+      env: NOXSESSION="tests-3.4"
+
+install:
+  - pip install --upgrade pip setuptools nox pyserial progress
+  - pip install .
+
+script: nox --session "$NOXSESSION"

ALTERNATIVES.md

@@ -0,0 +1,58 @@
+
+# Alternative tools
+
+
+## Stm32CubeProgrammer
+
+Official cross-platform tool by ST, with GUI and CLI versions.
+
+Supports all bootloader protocols (UART, I2C, SPI, USB DFU, CAN).
+Supports OTP memory and option bytes.
+
+https://www.st.com/en/development-tools/stm32cubeprog.html
+
+
+## STM32 Flash loader demonstrator (Flasher-stm32)
+
+Windows tool by ST.
+
+It comes with a command-line version and source code.
+
+https://www.st.com/en/development-tools/flasher-stm32.html
+
+
+## STM32 ST-Link utility
+
+This is replaced by Stm32CubProgrammer (see above).
+
+https://www.st.com/en/development-tools/stsw-link004.html
+
+
+## stm32flash
+
+Open source flashing tool in C.
+
+Supports UART and SPI, and covers many STM32 devices.
+This is probably a good choice if you're looking for speed.
+
+https://sourceforge.net/projects/stm32flash/
+
+
+## ST-flash
+
+This is open re-implementation of the ST-Link tools.
+
+https://github.com/stlink-org/stlink st-flash
+
+
+## stm32flash-lib
+
+Java library allowing to flash STM32 microcontrollers over UART.
+
+https://github.com/grevaillot/stm32flash-lib
+
+
+## GigaDevice tools
+
+GigaDevice offers the GD-Link Programmer to work with the GD-Link debug adapter,
+and GigaDevice MCU ISP Programmer.

CHANGELOG.md

@@ -0,0 +1,137 @@
+
+# Changelog
+What changed in which version.
+
+
+## [0.7.0] - 2023-10-12
+
+### Added
+* Support ST BlueNRG-1 and BlueNRG-2 devices.
+* Support ST STM32H7 series devices.
+* Allow to erase specific pages of flash memory.
+* Add command-line switch to protect flash against readout.
+* Support Intel hex file format.
+* Adopt `flit` as build system.
+* Adopt `bump-my-version` as version bumper.
+
+### Fixed
+* Erasing was impossible due to --length not being supplied.
+
+### Cleaned
+* Move argument-parsing code to separate file.
+* Use long-form argument names in help text and error messages.
+* Use IntEnum for commands and responses.
+
+
+
+## [0.6.0] - 2023-10-09
+
+Yanked on 2023-10-12 due to bug when erasing.  Use 0.7.0 instead.
+
+### Added
+* `#59` Continuous Integration: start running tests and linters on GitHub Actions.
+* `#42` `#43` Find flash size for non-standard MCUs (F4, L0).
+* Support STM32H7 series.
+* Packaging: auto-generate the help output using `cog`.
+* Support STM32WL.
+* Support Python 3.9 - 3.11.
+
+### Changed
+* `#46` `#48` Flush the UART read buffer after MCU reset.
+* Use argparse instead of optparse.
+* Drop support for Python 2, 3.4 - 3.8.
+
+### Fixed
+* `#44` Support flash page size higher than 255.
+* `#64` Properly parse address and length given as hexadecimal value.
+* `#62` Properly pass device family argument.
+
+### Documented
+* `#13` Describe how to extend Stm32Loader.
+* `#52` Describe alternative ways to execute the module.
+* `#58` Add a list of similar tools.
+
+
+## [0.5.1] - 2019-12-31
+* `#25` Fix bug: Mass memory erase by byq77.
+* `#28` Add support for STM32L4 by rdaforno.
+* `#29` Add support for more STM32F0 ids by stawiski .
+* `#30` Add support for STM32F3 by float32.
+* `#32` Add support for STM32G0x1 by AlexKlimaj.
+* `#33` More robust bootloader activation by hiviah.
+* `#35` Support Python 3.8
+* `#20` Add a 'read flash' example to README
+* `#34` Add --version argument
+
+
+## [0.5.0] - 2019-05-02
+* `#17` Add support for STM32F03xx4/6 by omerk.
+* Drop support for Python 3.2 and 3.3.
+
+
+## [0.4.0] - 2019-04-19
+* `#8`: Add support for STM32F7 mcus. By sam-bristow.
+* `#9`: Support data writes smaller than 256 bytes. By NINI1988.
+* `#10`: Make stm32loader useful as a library.
+* `#4`: Bring back support for progress bar.
+* `#12`: Allow to supply the serial port as an environment variable.
+* `#11`: Support paged erase in extended (two-byte addressing) erase mode.
+       Note: this is not yet tested on hardware.
+* Start using code linting and unit tests.
+* Start using Continuous Integration (Travis CI).
+
+
+## [0.3.3] - 2018-08-08
+* Bugfix: write data, not [data]. By Atokulus.
+
+
+## [0.3.2] - 2018-07-31
+* Publish on Python Package Index.
+* Make stm32loader executable as a module.
+* Expose stm32loader as a console script (stm32loader.exe on Windows).
+
+
+## [0.3.1] -- 2018-07-31
+* Make stm32loader installable and importable as a package.
+* Make write_memory faster (by Atokulus, see `#1`).
+
+
+## [0.3.0] - 2018-04-27
+* Add version number.
+* Add this changelog.
+* Improve documentation.
+* Support ST BlueNRG devices (configurable parity).
+* Add Wiznet W7500 / SweetPeas bootloader chip ID.
+* Fix ack-related bugs in (un)protect methods.
+* Add 'unprotect' command-line option.
+* Read device UID.
+* Read device flash size.
+* Refactor __main__ functionality into methods.
+
+
+## 2018-05
+* Make RTS/DTR (boot0/reset) configurable (polarity, swap).
+
+
+## 2018-04
+* Restore Python 2 compatibility.
+
+
+## 2018-03
+* Add support for Python 3.
+* Remove Psyco and progressbar support.
+* Fix checksum calculation bug for paged erase.
+
+
+## 2014-04
+* Add `-g <address>` (GO command).
+* Add known chip IDs.
+* Implement extended erase for STM32 F2/F4.
+
+
+## 2013-10
+* Add Windows compatibility.
+
+
+## 2009-04
+* Add GPL license.