diff --git a/docs/filter/base64.md b/docs/filter/base64.md new file mode 100644 index 000000000..61faa8d6b --- /dev/null +++ b/docs/filter/base64.md @@ -0,0 +1,13 @@ +# Base64 + +```{eval-rst} +.. automodule:: numcodecs.base64 + +.. autoclass:: Base64 + + .. autoattribute:: codec_id + .. automethod:: encode + .. automethod:: decode + .. automethod:: get_config + .. automethod:: from_config +``` diff --git a/docs/filter/index.md b/docs/filter/index.md index cd36c71cb..06bf36498 100644 --- a/docs/filter/index.md +++ b/docs/filter/index.md @@ -11,4 +11,5 @@ packbits categorize astype shuffle +base64 ``` diff --git a/docs/release.md b/docs/release.md index ee7709335..6c3509aa9 100644 --- a/docs/release.md +++ b/docs/release.md @@ -14,6 +14,11 @@ ## Unreleased +### Documentation + +* Add the Base64 codec to the filter API reference, with an encoding and decoding example. + By {user}`Wentao Tong `, {issue}`587` + (release_0.17.1)= ## 0.17.1 diff --git a/src/numcodecs/base64.py b/src/numcodecs/base64.py index 307c6d52b..f6c1f119b 100644 --- a/src/numcodecs/base64.py +++ b/src/numcodecs/base64.py @@ -5,7 +5,16 @@ class Base64(Codec): - """Codec providing base64 compression via the Python standard library.""" + """Codec providing Base64 encoding via the Python standard library. + + Examples + -------- + >>> codec = Base64() + >>> codec.encode(b'hello') + b'aGVsbG8=' + >>> codec.decode(b'aGVsbG8=') + b'hello' + """ codec_id = "base64"