feat(docs): created sphinx documentation (#1)

.gitignore

@@ -129,4 +129,6 @@ dmypy.json
 .pyre/
 
 # Editor
-.vscode/
+.vscode/
+
+.DS_Store

README.md

@@ -12,29 +12,36 @@ TODO
 from rstr import Rstr
 
 # Initialise the rstr client with the URL to your rstr server
-# and your API Tokent.
+# and your API Token.
+# NOTE: these can be specified as environment variables
+# >>> export RSTR_URL="https://my-rstr.rs"
+# >>> export RSTR_API_TOKEN="MY_API_TOKEN"
 url = "https://my-rstr.rs"
 token = "MY_API_TOKEN"
-rstr = Rstr(url, token)
 
-# Add a file to the blob store
-refs = rstr.add(["/path/to/my/file.txt"])
+with Rstr(url=url, token=token) as rstr:
+    # Add a file to the blob store
+    refs = rstr.add(["/path/to/my/file.txt"])
 
-# You will get a list of references to your blobs
-# e.g. ["f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de"]
+    # You will get a list of references to your blobs
+    # e.g. ["f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de"]
 
-# You can then use the reference to retrieve your blob
-ref = refs[0]
-blob = rstr.get(ref)
+    # You can then use the reference to retrieve your blob
+    ref = refs[0]
+    blob = rstr.get(ref)
 
 print(blob)
 # Blob(f29bc64a9d)
 
 print(blob.metadata)
 # BlobMetadata('file.txt', 'text/plain', 20 bytes)
 
-# The blob can be permanently deleted from the blob store with
-rstr.delete(ref)
+# You can access the binary content of the blob with:
+# content = blob.content
+
+# The blob can be permanently deleted from the blob store with:
+with Rstr(url=url, token=token) as rstr:
+    rstr.delete(ref)
 ```
 
 ## License

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/client.rst

@@ -0,0 +1,7 @@
+Client API
+==========
+.. module:: rstr
+
+.. autoclass:: Rstr
+   :members:
+

docs/source/conf.py

@@ -0,0 +1,99 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+import alabaster
+
+sys.path.insert(0, os.path.abspath("../../"))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "rstr-client"
+copyright = "2021, Giuseppe Papallo"
+author = "Giuseppe Papallo"
+
+# The full version, including alpha/beta/rc tags
+release = "0.1.0"
+version = "0.1.0"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "alabaster",
+]
+autosummary_generate = True  # Turn on sphinx.ext.autosummary
+autodoc_default_options = {
+    "show-inheritance": False,
+    # "members": True,
+    "member-order": "bysource",
+    # "special-members": "__init__",
+    # "undoc-members": True,
+    "exclude-members": "__weakref__",
+}
+autoclass_content = "init"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
+html_theme_path = [alabaster.get_path()]
+
+html_sidebars = {
+    "**": [
+        "about.html",
+        "navigation.html",
+        "relations.html",
+        "searchbox.html",
+        # "donate.html",
+    ]
+}
+
+html_theme_options = {
+    "code_font_family": '"SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace',
+    "description": "A python client for the rstr blob store.",
+    "code_font_size": "0.8em",
+    "fixed_sidebar": True,
+    "github_banner": False,
+    "github_button": True,
+    "github_type": "star",
+    "github_user": "giuppep",
+    "github_repo": "rstr-client",
+    "extra_nav_links": {"rstr server": "https://github.com/giuppep/rstr"},
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ["_static"]
+
+autodoc_mock_imports = ["requests"]

docs/source/exceptions.rst

@@ -0,0 +1,5 @@
+Exceptions
+==========
+
+.. automodule:: rstr.exceptions
+   :members:

docs/source/index.rst

@@ -0,0 +1,27 @@
+Welcome to rstr-client's documentation!
+=======================================
+
+``Rstr`` blob store client
+--------------------------
+
+.. automodule:: rstr
+   :noindex:
+
+Contents
+********
+
+.. toctree::
+   :maxdepth: 2
+
+   client
+   models
+   exceptions
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/models.rst

@@ -0,0 +1,11 @@
+Data Models
+===========
+.. module:: rstr.models
+
+.. autoclass:: Blob
+    :members:
+
+
+.. autoclass:: BlobMetadata
+    :members:
+

rstr/__init__.py

@@ -1,3 +1,29 @@
+"""Python client for the `Rstr <https://github.com/giuppep/rstr>`_ blob store.
+
+Basic usage
+***********
+
+Upload a file to the blob store:
+
+
+   >>> from rstr import Rstr
+   >>> url = "https://my-rstr.rs"
+   >>> token = "*****"
+   >>> with Rstr(url=url, token=token) as rstr:
+   >>>     refs = rstr.add(["/path/to/my/file.pdf"])
+   >>> print(refs)
+   ["eb8471d882d2a90a4b1c60dcaa41fc5d0c33143f8ebc910247453a130e74ca68"]
+
+Retrieve a file from the blob store:
+
+   >>> with Rstr(url=url, token=token) as rstr:
+   >>>     blob = rstr.get(refs[0])
+   >>> print(blob)
+   Blob(eb8471d882)
+   >>> blob.content
+   b"..."
+
+"""
 from .client import Rstr
 from .exceptions import (
     BlobNotFound,