Added down examples to doc

WardPearce · Mar 3, 2021 · d17e569 · d17e569
1 parent b78ab28
commit d17e569
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/requirements.txt b/requirements.txt
@@ -3,4 +3,4 @@ aiofile>=3.1.0
 aiofiles
 asynctest
 sphinxcontrib-trio
-git+https://github.com/bashtage/sphinx-material.git
+sphinx-material
diff --git a/source/examples.rst b/source/examples.rst
@@ -79,3 +79,22 @@ Uploading parts
     parts = file.parts()
     parts.file(pathway="path/to/weeb/file.jpg")
     parts.finish()
+
+Downloading
+~~~~~~~~~~~
+.. code-block:: python
+
+    data = bucket.file(file_id="...").download()
+
+Async download iterate
+~~~~~~~~~~~~~~~~~~~~~~
+.. code-block:: python
+
+    async for data in bucket.file(file_id="...").download_iterate():
+        pass
+
+Download by name
+~~~~~~~~~~~~~~~~
+.. code-block:: python
+
+    data = client.download_by_name(bucket_name="...", file_name="foobar.jpg")