Merge pull request #126 from ethereum/release-notes-0.3.0

Compile release notes for v0.3.0

docs/release_notes.rst

@@ -3,6 +3,50 @@ Release Notes
 
 .. towncrier release notes start
 
+py-ssz v0.3.0 (2022-08-19)
+--------------------------
+
+Breaking changes
+~~~~~~~~~~~~~~~~
+
+- Dropping official support for Python 3.6 (although it still worked as of the last test run). (`#125 <https://github.com/ethereum/py-ssz/issues/125>`__)
+
+
+Features
+~~~~~~~~
+
+- Add a :class:`~ssz.sedes.byte_list.ByteList` sedes that is more convenient and more performant. With
+  ByteList, the caller can decode a :class:`bytes` object, rather than passing in a list of
+  single-byte elements. (`#118 <https://github.com/ethereum/py-ssz/issues/118>`__)
+
+
+Bugfixes
+~~~~~~~~
+
+- Reject empty bytes at the end of a bitlist as invalid (`#109 <https://github.com/ethereum/py-ssz/issues/109>`__)
+- Reject vectors and bitvectors of length 0 as invalid, as defined in the spec. (`#111 <https://github.com/ethereum/py-ssz/issues/111>`__)
+- Enforce that vector types must have a maximum length of 1 or more, and lists may have a 0 max length (`#116 <https://github.com/ethereum/py-ssz/issues/116>`__)
+
+
+Improved Documentation
+~~~~~~~~~~~~~~~~~~~~~~
+
+- Sort release notes with most recent on top (`#124 <https://github.com/ethereum/py-ssz/issues/124>`__)
+
+
+Internal Changes - for py-ssz Contributors
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Upgrade black to a stable version, and pass newest style checks (`#120 <https://github.com/ethereum/py-ssz/issues/120>`__)
+- Use the latest project template, which gives many developer-focused benefits: in making release
+  notes, releasing new versions, etc. (`#121 <https://github.com/ethereum/py-ssz/issues/121>`__)
+- Miscellaneous changes (`#124 <https://github.com/ethereum/py-ssz/issues/124>`__):
+
+  - Run black autoformat, as part of ``make lint-roll``
+  - Added some tests to check length validation of :class:`~ssz.sedes.byte_list.ByteList` and :class:`~ssz.sedes.byte_vector.ByteVector`
+  - When generating website docs from docstrings, skip tests
+
+
 v0.2.4
 --------------
 

docs/ssz.cache.rst

@@ -0,0 +1,30 @@
+ssz.cache package
+=================
+
+Submodules
+----------
+
+ssz.cache.cache module
+----------------------
+
+.. automodule:: ssz.cache.cache
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.cache.utils module
+----------------------
+
+.. automodule:: ssz.cache.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: ssz.cache
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/ssz.rst

@@ -0,0 +1,127 @@
+ssz package
+===========
+
+Subpackages
+-----------
+
+.. toctree::
+
+    ssz.cache
+    ssz.sedes
+    ssz.tools
+
+Submodules
+----------
+
+ssz.abc module
+--------------
+
+.. automodule:: ssz.abc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.codec module
+----------------
+
+.. automodule:: ssz.codec
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.constants module
+--------------------
+
+.. automodule:: ssz.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.exceptions module
+---------------------
+
+.. automodule:: ssz.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.hash module
+---------------
+
+.. automodule:: ssz.hash
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.hash\_tree module
+---------------------
+
+.. automodule:: ssz.hash_tree
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.hashable\_container module
+------------------------------
+
+.. automodule:: ssz.hashable_container
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.hashable\_list module
+-------------------------
+
+.. automodule:: ssz.hashable_list
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.hashable\_structure module
+------------------------------
+
+.. automodule:: ssz.hashable_structure
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.hashable\_vector module
+---------------------------
+
+.. automodule:: ssz.hashable_vector
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.tree\_hash module
+---------------------
+
+.. automodule:: ssz.tree_hash
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.typing module
+-----------------
+
+.. automodule:: ssz.typing
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.utils module
+----------------
+
+.. automodule:: ssz.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: ssz
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/ssz.sedes.rst

@@ -0,0 +1,126 @@
+ssz.sedes package
+=================
+
+Submodules
+----------
+
+ssz.sedes.base module
+---------------------
+
+.. automodule:: ssz.sedes.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.basic module
+----------------------
+
+.. automodule:: ssz.sedes.basic
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.bitlist module
+------------------------
+
+.. automodule:: ssz.sedes.bitlist
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.bitvector module
+--------------------------
+
+.. automodule:: ssz.sedes.bitvector
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.boolean module
+------------------------
+
+.. automodule:: ssz.sedes.boolean
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.byte module
+---------------------
+
+.. automodule:: ssz.sedes.byte
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.byte\_list module
+---------------------------
+
+.. automodule:: ssz.sedes.byte_list
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.byte\_vector module
+-----------------------------
+
+.. automodule:: ssz.sedes.byte_vector
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.container module
+--------------------------
+
+.. automodule:: ssz.sedes.container
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.list module
+---------------------
+
+.. automodule:: ssz.sedes.list
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.serializable module
+-----------------------------
+
+.. automodule:: ssz.sedes.serializable
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.signed\_serializable module
+-------------------------------------
+
+.. automodule:: ssz.sedes.signed_serializable
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.uint module
+---------------------
+
+.. automodule:: ssz.sedes.uint
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.sedes.vector module
+-----------------------
+
+.. automodule:: ssz.sedes.vector
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: ssz.sedes
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/ssz.tools.rst

@@ -0,0 +1,38 @@
+ssz.tools package
+=================
+
+Submodules
+----------
+
+ssz.tools.codec module
+----------------------
+
+.. automodule:: ssz.tools.codec
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.tools.dump module
+---------------------
+
+.. automodule:: ssz.tools.dump
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ssz.tools.parse module
+----------------------
+
+.. automodule:: ssz.tools.parse
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: ssz.tools
+    :members:
+    :undoc-members:
+    :show-inheritance: