Docs (#6)

* docs: setup

* docs: write basic documentation

* chore: fix lock file

* chore: calm pre-commit down

Author: anand2312

README.md

@@ -14,9 +14,10 @@ from storage3 import create_client
 
 url = "https://<your_supabase_id>.supabase.co/storage/v1"
 key = "<your api key>"
+headers = {"apiKey": key, "Authorization": f"Bearer {key}"}
 
 # pass in is_async=True to create an async client
-storage_client = create_client(url, key, is_async=False)
+storage_client = create_client(url, headers, is_async=False)
 
 storage_client.list_buckets()
 ```

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     = .
+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/api/bucket.rst

@@ -0,0 +1,9 @@
+Bucket
+======
+
+.. autoclass:: storage3._async.file_api.AsyncBucket
+    :inherited-members:
+
+
+.. autoclass:: storage3._async.file_api.AsyncBucketProxy
+    :inherited-members:

docs/api/client.rst

@@ -0,0 +1,11 @@
+Client
+======
+
+The entrypoint to the library is the Client class. To interact with the Storage API, you make an instance of this class.
+
+
+.. autofunction:: storage3.create_client
+
+.. autoclass:: storage3.AsyncStorageClient
+    :members:
+    :inherited-members:

docs/api/index.rst

@@ -0,0 +1,14 @@
+API Reference
+=============
+
+.. note::
+    The library offers both synchronous and asynchronous clients.
+    Note that the synchronous and asynchronous classes all provide the exact same interface.
+    Only the async client and it's methods are documented here.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: API Reference:
+
+      Client <client>
+      Bucket <bucket>

docs/conf.py

@@ -0,0 +1,57 @@
+# 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
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "storage-py"
+copyright = (
+    "2022, Anand Krishna, Daniel Reinón García, Joel Lee, Leynier Gutiérrez González"
+)
+author = "Anand Krishna, Daniel Reinón García, Joel Lee, Leynier Gutiérrez González"
+
+
+# -- 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.extlinks",
+]
+
+# 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 = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- 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 = "press"
+
+# 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"]

docs/examples/index.rst

@@ -0,0 +1,40 @@
+Welcome to storage-py's documentation!
+======================================
+
+Python Client library for `Supabase Storage API <https://supabase.com/storage>`_
+
+.. attention::
+   If you find any bugs, please file an `issue <https://github.com/supabase-community/storage-py/issues/>`_.
+
+
+Installation
+============
+
+Requirements:
+
+- Python >= 3.7
+
+**With pip:**
+::
+
+   pip install storage3
+
+**With poetry:**
+::
+
+   poetry add storage3
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+      API Reference </api/index>
+      Examples </examples/index>
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/index.rst

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd