Add examples

Author: emmatyping

Doc/library/compression.zstd.rst

@@ -704,11 +704,65 @@ Miscellaneous
       recorded in the frame header, the frame may or may not need a dictionary
       to be decoded, or the ID of such a dictionary is not specified.
 
+
 .. attribute:: COMPRESSION_LEVEL_DEFAULT
 
    The default compression level for Zstandard, currently '3'.
 
+
 .. attribute:: zstd_version_info
 
    Version number of the runtime zstd library as a tuple of int
    (major, minor, release).
+
+
+Examples
+--------
+
+Reading in a compressed file::
+
+   from compression import zstd
+   with zstd.open("file.zst") as f:
+       file_content = f.read()
+
+Creating a compressed file::
+
+   from compression import zstd
+   data = b"Insert Data Here"
+   with zstd.open("file.zst", "w") as f:
+       f.write(data)
+
+Compressing data in memory::
+
+   from compression import zstd
+   data_in = b"Insert Data Here"
+   data_out = zstd.compress(data_in)
+
+Incremental compression::
+
+   from compression import zstd
+   comp = zstd.ZstdCompressor()
+   out1 = comp.compress(b"Some data\n")
+   out2 = comp.compress(b"Another piece of data\n")
+   out3 = comp.compress(b"Even more data\n")
+   out4 = comp.flush()
+   # Concatenate all the partial results:
+   result = b"".join([out1, out2, out3, out4])
+
+Writing compressed data to an already-open file::
+
+   from compression import zstd
+   with open("file.zst", "wb") as f:
+       f.write(b"This data will not be compressed\n")
+       with zstd.open(f, "w") as zstf:
+           zstf.write(b"This *will* be compressed\n")
+       f.write(b"Not compressed\n")
+
+Creating a compressed file using compression parameters::
+
+   from compression import zstd
+   options = {
+      zstd.CompressionParameter.checksum_flag: 1
+   }
+   with zstd.open("file.zst", "w", options=options) as f:
+       f.write(b"blah blah blah")