Updated workflows and metadata

Signed-off-by: Andrea Zoppi <[email protected]>
TexZK · Oct 5, 2024 · f8d3aec · f8d3aec
1 parent 660e14e
commit f8d3aec
Show file tree

Hide file tree

Showing 17 changed files with 118 additions and 90 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -4,9 +4,12 @@ on:
   push:
     branches:
       - main
+      - rc
 
   pull_request:
 
+  workflow_dispatch:
+
 jobs:
   build:
     runs-on: ${{ matrix.platform }}
@@ -20,8 +23,6 @@ jobs:
           - windows-latest
 
         python-version:
-          - '3.7'
-          - '3.8'
           - '3.9'
           - '3.10'
           - '3.11'
@@ -43,15 +44,15 @@ jobs:
         run: tox
 
       - name: Upload coverage
-        if: ${{ matrix.platform == 'ubuntu-latest' && matrix.python-version == '3.11' }}
+        if: ${{ matrix.platform == 'ubuntu-latest' && matrix.python-version == '3.12' }}
         uses: actions/upload-artifact@v4
         with:
           name: hexrec-coverage
           path: coverage.xml
           if-no-files-found: error
 
       - name: Upload to codecov
-        if: ${{ matrix.platform == 'ubuntu-latest' && matrix.python-version == '3.11' }}
+        if: ${{ matrix.platform == 'ubuntu-latest' && matrix.python-version == '3.12' }}
         uses: codecov/codecov-action@v4
         with:
           fail_ci_if_error: true

diff --git a/.github/workflows/packaging.yml b/.github/workflows/packaging.yml
@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - rc
 
   pull_request:
 
@@ -17,8 +18,6 @@ jobs:
       max-parallel: 4
       matrix:
         python-version:
-          - '3.7'
-          - '3.8'
           - '3.9'
           - '3.10'
           - '3.11'

diff --git a/.gitignore b/.gitignore
@@ -10,7 +10,7 @@ dist
 build
 eggs
 .eggs
-env
+*env
 parts
 bin
 var
@@ -20,8 +20,6 @@ develop-eggs
 .installed.cfg
 lib
 lib64
-venv*/
-pyvenv*/
 tmp*
 
 # Installer logs
@@ -48,6 +46,7 @@ tests/*.html
 .idea
 *.iml
 *.komodoproject
+.vscode
 
 # Complexity
 output/*.html

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,8 +1,14 @@
 Changelog
 =========
 
-0.4.0 (TBD)
------------
+0.4.1 (2024-10-05)
+------------------
+
+* Minor workflow and metadata updates.
+
+
+0.4.0 (2024-03-08)
+------------------
 
 * Library rewritten from scratch (not backwards compatible).
 * Added new object oriented API, hopefully more user friendly.

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -18,6 +18,7 @@ include README.rst
 include requirements.txt
 include pyproject.toml
 include setup.cfg
+include setup.py
 include tox.ini
 
 global-exclude *.py[cod] __pycache__ *.so *.dylib
diff --git a/README.rst b/README.rst
@@ -27,7 +27,7 @@ Overview
 
 .. |codecov| image:: https://codecov.io/gh/TexZK/hexrec/branch/main/graphs/badge.svg?branch=main
     :alt: Coverage Status
-    :target: https://codecov.io/github/TexZK/hexrec
+    :target: https://app.codecov.io/github/TexZK/hexrec
 
 .. |version| image:: https://img.shields.io/pypi/v/hexrec.svg
     :alt: PyPI Package latest release

diff --git a/docs/_autosummary/hexrec.formats.asciihex.AsciiHexTag.rst b/docs/_autosummary/hexrec.formats.asciihex.AsciiHexTag.rst
@@ -1,4 +1,4 @@
-AsciiHexTag
+AsciiHexTag
 ===========
 
 .. currentmodule:: hexrec.formats.asciihex
@@ -16,13 +16,13 @@ AsciiHexTag
 
     .. autosummary::
 
+        ~AsciiHexTag.real
+        ~AsciiHexTag.imag
+        ~AsciiHexTag.numerator
+        ~AsciiHexTag.denominator
         ~AsciiHexTag.DATA
         ~AsciiHexTag.ADDRESS
         ~AsciiHexTag.CHECKSUM
-        ~AsciiHexTag.denominator
-        ~AsciiHexTag.imag
-        ~AsciiHexTag.numerator
-        ~AsciiHexTag.real
 
 
 
@@ -34,13 +34,14 @@ AsciiHexTag
     .. autosummary::
         :nosignatures:
 
-        ~AsciiHexTag.is_address
-        ~AsciiHexTag.is_checksum
-        ~AsciiHexTag.__init__
-        ~AsciiHexTag.as_integer_ratio
-        ~AsciiHexTag.bit_count
-        ~AsciiHexTag.bit_length
+        ~AsciiHexTag.is_data
+        ~AsciiHexTag.is_file_termination
         ~AsciiHexTag.conjugate
-        ~AsciiHexTag.from_bytes
+        ~AsciiHexTag.bit_length
+        ~AsciiHexTag.bit_count
         ~AsciiHexTag.to_bytes
+        ~AsciiHexTag.from_bytes
+        ~AsciiHexTag.as_integer_ratio
+        ~AsciiHexTag.is_address
+        ~AsciiHexTag.is_checksum
 
diff --git a/docs/_autosummary/hexrec.formats.avr.AvrTag.rst b/docs/_autosummary/hexrec.formats.avr.AvrTag.rst
@@ -1,4 +1,4 @@
-AvrTag
+AvrTag
 ======
 
 .. currentmodule:: hexrec.formats.avr
@@ -23,3 +23,11 @@ AvrTag
 
 
 
+    .. rubric:: Methods
+
+    .. autosummary::
+        :nosignatures:
+
+        ~AvrTag.is_data
+        ~AvrTag.is_file_termination
+
diff --git a/docs/_autosummary/hexrec.formats.ihex.IhexTag.rst b/docs/_autosummary/hexrec.formats.ihex.IhexTag.rst
@@ -1,4 +1,4 @@
-IhexTag
+IhexTag
 =======
 
 .. currentmodule:: hexrec.formats.ihex
@@ -16,16 +16,16 @@ IhexTag
 
     .. autosummary::
 
+        ~IhexTag.real
+        ~IhexTag.imag
+        ~IhexTag.numerator
+        ~IhexTag.denominator
         ~IhexTag.DATA
         ~IhexTag.END_OF_FILE
         ~IhexTag.EXTENDED_SEGMENT_ADDRESS
         ~IhexTag.START_SEGMENT_ADDRESS
         ~IhexTag.EXTENDED_LINEAR_ADDRESS
         ~IhexTag.START_LINEAR_ADDRESS
-        ~IhexTag.denominator
-        ~IhexTag.imag
-        ~IhexTag.numerator
-        ~IhexTag.real
 
 
 
@@ -37,14 +37,15 @@ IhexTag
     .. autosummary::
         :nosignatures:
 
+        ~IhexTag.is_data
+        ~IhexTag.is_file_termination
+        ~IhexTag.conjugate
+        ~IhexTag.bit_length
+        ~IhexTag.bit_count
+        ~IhexTag.to_bytes
+        ~IhexTag.from_bytes
+        ~IhexTag.as_integer_ratio
         ~IhexTag.is_eof
         ~IhexTag.is_extension
         ~IhexTag.is_start
-        ~IhexTag.__init__
-        ~IhexTag.as_integer_ratio
-        ~IhexTag.bit_count
-        ~IhexTag.bit_length
-        ~IhexTag.conjugate
-        ~IhexTag.from_bytes
-        ~IhexTag.to_bytes
 
diff --git a/docs/_autosummary/hexrec.formats.mos.MosTag.rst b/docs/_autosummary/hexrec.formats.mos.MosTag.rst
@@ -1,4 +1,4 @@
-MosTag
+MosTag
 ======
 
 .. currentmodule:: hexrec.formats.mos
@@ -16,12 +16,12 @@ MosTag
 
     .. autosummary::
 
-        ~MosTag.DATA
-        ~MosTag.EOF
-        ~MosTag.denominator
+        ~MosTag.real
         ~MosTag.imag
         ~MosTag.numerator
-        ~MosTag.real
+        ~MosTag.denominator
+        ~MosTag.DATA
+        ~MosTag.EOF
 
 
 
@@ -33,12 +33,13 @@ MosTag
     .. autosummary::
         :nosignatures:
 
-        ~MosTag.is_eof
-        ~MosTag.__init__
-        ~MosTag.as_integer_ratio
-        ~MosTag.bit_count
-        ~MosTag.bit_length
+        ~MosTag.is_data
+        ~MosTag.is_file_termination
         ~MosTag.conjugate
-        ~MosTag.from_bytes
+        ~MosTag.bit_length
+        ~MosTag.bit_count
         ~MosTag.to_bytes
+        ~MosTag.from_bytes
+        ~MosTag.as_integer_ratio
+        ~MosTag.is_eof
 
diff --git a/docs/_autosummary/hexrec.formats.raw.RawTag.rst b/docs/_autosummary/hexrec.formats.raw.RawTag.rst
@@ -1,4 +1,4 @@
-RawTag
+RawTag
 ======
 
 .. currentmodule:: hexrec.formats.raw
@@ -23,3 +23,11 @@ RawTag
 
 
 
+    .. rubric:: Methods
+
+    .. autosummary::
+        :nosignatures:
+
+        ~RawTag.is_data
+        ~RawTag.is_file_termination
+
diff --git a/docs/_autosummary/hexrec.formats.srec.SrecTag.rst b/docs/_autosummary/hexrec.formats.srec.SrecTag.rst
@@ -1,4 +1,4 @@
-SrecTag
+SrecTag
 =======
 
 .. currentmodule:: hexrec.formats.srec
@@ -16,6 +16,10 @@ SrecTag
 
     .. autosummary::
 
+        ~SrecTag.real
+        ~SrecTag.imag
+        ~SrecTag.numerator
+        ~SrecTag.denominator
         ~SrecTag.HEADER
         ~SrecTag.DATA_16
         ~SrecTag.DATA_24
@@ -26,10 +30,6 @@ SrecTag
         ~SrecTag.START_32
         ~SrecTag.START_24
         ~SrecTag.START_16
-        ~SrecTag.denominator
-        ~SrecTag.imag
-        ~SrecTag.numerator
-        ~SrecTag.real
 
 
 
@@ -41,6 +41,14 @@ SrecTag
     .. autosummary::
         :nosignatures:
 
+        ~SrecTag.is_data
+        ~SrecTag.is_file_termination
+        ~SrecTag.conjugate
+        ~SrecTag.bit_length
+        ~SrecTag.bit_count
+        ~SrecTag.to_bytes
+        ~SrecTag.from_bytes
+        ~SrecTag.as_integer_ratio
         ~SrecTag.fit_count_tag
         ~SrecTag.fit_data_tag
         ~SrecTag.fit_start_tag
@@ -51,11 +59,4 @@ SrecTag
         ~SrecTag.is_count
         ~SrecTag.is_header
         ~SrecTag.is_start
-        ~SrecTag.__init__
-        ~SrecTag.as_integer_ratio
-        ~SrecTag.bit_count
-        ~SrecTag.bit_length
-        ~SrecTag.conjugate
-        ~SrecTag.from_bytes
-        ~SrecTag.to_bytes
 
diff --git a/docs/_autosummary/hexrec.formats.titxt.TiTxtTag.rst b/docs/_autosummary/hexrec.formats.titxt.TiTxtTag.rst
@@ -1,4 +1,4 @@
-TiTxtTag
+TiTxtTag
 ========
 
 .. currentmodule:: hexrec.formats.titxt
@@ -16,13 +16,13 @@ TiTxtTag
 
     .. autosummary::
 
+        ~TiTxtTag.real
+        ~TiTxtTag.imag
+        ~TiTxtTag.numerator
+        ~TiTxtTag.denominator
         ~TiTxtTag.DATA
         ~TiTxtTag.ADDRESS
         ~TiTxtTag.EOF
-        ~TiTxtTag.denominator
-        ~TiTxtTag.imag
-        ~TiTxtTag.numerator
-        ~TiTxtTag.real
 
 
 
@@ -34,13 +34,14 @@ TiTxtTag
     .. autosummary::
         :nosignatures:
 
-        ~TiTxtTag.is_address
-        ~TiTxtTag.is_eof
-        ~TiTxtTag.__init__
-        ~TiTxtTag.as_integer_ratio
-        ~TiTxtTag.bit_count
-        ~TiTxtTag.bit_length
+        ~TiTxtTag.is_data
+        ~TiTxtTag.is_file_termination
         ~TiTxtTag.conjugate
-        ~TiTxtTag.from_bytes
+        ~TiTxtTag.bit_length
+        ~TiTxtTag.bit_count
         ~TiTxtTag.to_bytes
+        ~TiTxtTag.from_bytes
+        ~TiTxtTag.as_integer_ratio
+        ~TiTxtTag.is_address
+        ~TiTxtTag.is_eof