Add some basic docs for Backblaze B2 driver.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/b13376bd Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/b13376bd Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/b13376bd Branch: refs/heads/trunk Commit: b13376bd1440194531330336ce389b4a4193142d Parents: 484d974 Author: Tomaz Muraus <[email protected]> Authored: Mon Jan 18 11:49:44 2016 +0100 Committer: Tomaz Muraus <[email protected]> Committed: Mon Jan 18 11:49:44 2016 +0100 ---------------------------------------------------------------------- .../_static/images/provider_logos/backblaze.png | Bin 0 -> 6864 bytes .../storage/backblaze_b2/instantiate.py | 8 ++++ docs/storage/drivers/backblaze_b2.rst | 40 +++++++++++++++++++ 3 files changed, 48 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/b13376bd/docs/_static/images/provider_logos/backblaze.png ---------------------------------------------------------------------- diff --git a/docs/_static/images/provider_logos/backblaze.png b/docs/_static/images/provider_logos/backblaze.png new file mode 100644 index 0000000..5899a79 Binary files /dev/null and b/docs/_static/images/provider_logos/backblaze.png differ http://git-wip-us.apache.org/repos/asf/libcloud/blob/b13376bd/docs/examples/storage/backblaze_b2/instantiate.py ---------------------------------------------------------------------- diff --git a/docs/examples/storage/backblaze_b2/instantiate.py b/docs/examples/storage/backblaze_b2/instantiate.py new file mode 100644 index 0000000..2b0c9fc --- /dev/null +++ b/docs/examples/storage/backblaze_b2/instantiate.py @@ -0,0 +1,8 @@ +from libcloud.storage.types import Provider +from libcloud.storage.providers import get_driver + +account_id = 'XXXXXX' +application_key = 'YYYYYY' + +cls = get_driver(Provider.BACKBLAZE_B2) +driver = cls(account_id, application_key) http://git-wip-us.apache.org/repos/asf/libcloud/blob/b13376bd/docs/storage/drivers/backblaze_b2.rst ---------------------------------------------------------------------- diff --git a/docs/storage/drivers/backblaze_b2.rst b/docs/storage/drivers/backblaze_b2.rst new file mode 100644 index 0000000..af8d61b --- /dev/null +++ b/docs/storage/drivers/backblaze_b2.rst @@ -0,0 +1,40 @@ +Backblaze B2 Storage Driver Documentation +========================================= + +`Backblaze`_ is an online backup tool that allows Windows and Mac OS X users to +back up their data to an offsite data center. + +`Backblaze B2`_ is their cloud object storage offering similar to Amazon S3 and +other object storage services. + +.. figure:: /_static/images/provider_logos/backblaze.png + :align: center + :width: 300 + :target: https://www.backblaze.com/b2/cloud-storage.html + +Keep in mind that the service is currently in public beta and only users who +have signed up and received beta access can use it. To sign up for the beta +access, visit their website mentioned above. + +Instantiating a driver +---------------------- + +To instantiate the driver you need to pass your account id and application key +to the driver constructor as shown below. + +To access the account id, once we have admitted you into the beta you can login +to https://secure.backblaze.com/user_signin.htm, then click "buckets" and +"show account id and application key". + +.. literalinclude:: /examples/storage/backblaze_b2/instantiate.py + :language: python + +API Docs +-------- + +.. autoclass:: libcloud.storage.drivers.backblaze_b2.BackblazeB2StorageDriver + :members: + :inherited-members: + +.. _`Backblaze`: https://www.backblaze.com/ +.. _`Backblaze B2`: https://www.backblaze.com/b2/cloud-storage.html
