Added docs

.gitignore

@@ -127,3 +127,5 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+.vscode/

CHANGES

@@ -0,0 +1,8 @@
+Changelog
+=========
+
+
+Version 0.1
+-----------
+
+First public preview release.

README.rst

@@ -0,0 +1,2 @@
+Django gRPC Framework
+=====================

django_grpc_framework/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1'

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/changelog.rst

@@ -0,0 +1,3 @@
+.. _changes:
+
+.. include:: ../CHANGES

docs/conf.py

@@ -0,0 +1,63 @@
+# 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 = 'django-grpc-framework'
+copyright = '2020, Shipeng Feng'
+author = 'Shipeng Feng'
+
+# The full version, including alpha/beta/rc tags
+import pkg_resources
+try:
+    release = pkg_resources.get_distribution('djangogrpcframework').version
+except pkg_resources.DistributionNotFound:
+    print('To build the documentation, the distribution information of')
+    print('django-grpc-framework has to be available.  Run "setup.py develop"')
+    print('to setup the metadata.  A virtualenv is recommended!')
+    sys.exit(1)
+del pkg_resources
+
+
+# -- 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 = [
+]
+
+# 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 = 'alabaster'
+
+# 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/index.rst

@@ -0,0 +1,38 @@
+Django gRPC Framework
+=====================
+
+Django gRPC framework is a toolkit for building gRPC services with Django.
+
+
+User's Guide
+------------
+
+This part of the documentation begins with installation, followed by more
+instructions for building services.
+
+.. toctree::
+   :maxdepth: 2
+
+   installation
+   quickstart
+   tutorial/index
+
+
+Additional Stuff
+----------------
+
+Changelog and license here if you are interested.
+
+.. toctree::
+   :maxdepth: 2
+
+   changelog
+   license
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/installation.rst

@@ -0,0 +1,52 @@
+.. _installation:
+
+Installation
+============
+
+
+Requirements
+------------
+
+We requires the following:
+
+- Python (3.6,3.7,3.8)
+- Django (2.0,2.1,2.2,3.0)
+
+
+virtualenv
+----------
+
+Virtualenv might be something you want to use for development!  If you do not
+have it yet, try the following command::
+
+    $ sudo pip install virtualenv
+
+Since we have virtualenv installed now, let's create one working environment::
+
+    $ mkdir myproject
+    $ cd myproject
+    $ virtualenv venv
+    $ . venv/bin/activate
+
+It is time to get the django grpc framework::
+
+    $ pip install djangogrpcframework
+
+
+System Wide
+-----------
+
+Install it for all users on the system::
+
+    $ sudo pip install djangogrpcframework
+
+
+Development Version
+-------------------
+
+Try the latest version::
+
+    $ . venv/bin/activate
+    $ git clone https://github.com/fengsp/django-grpc-framework.git
+    $ cd django-grpc-framework
+    $ python setup.py develop

docs/license.rst

@@ -0,0 +1,8 @@
+.. _license:
+
+License
+=======
+
+This library is licensed under Apache License.
+
+.. include:: ../LICENSE

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

@@ -0,0 +1,6 @@
+.. _quickstart:
+
+Quickstart
+==========
+
+This page gives a introduction.

docs/tutorial/index.rst

@@ -0,0 +1,9 @@
+.. _tutorial:
+
+Tutorial
+========
+
+This part provides a basic introduction to working with Django gRPC framework.
+
+.. toctree::
+   :maxdepth: 2

setup.py

@@ -0,0 +1,32 @@
+import re
+from setuptools import find_packages, setup
+
+
+with open('django_grpc_framework/__init__.py', 'rb') as f:
+    version = str(eval(re.search(r'__version__\s+=\s+(.*)',
+        f.read().decode('utf-8')).group(1)))
+
+
+setup(
+    name='djangogrpcframework',
+    version=version,
+    description='gRPC for Django.',
+    url='https://github.com/fengsp/django-grpc-framework',
+    author_name='Shipeng Feng',
+    author_email='fsp261@gmail.com',
+    packages=find_packages(),
+    install_requires=[],
+    python_requires=">=3.6",
+    zip_safe=False,
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: Apache Software License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3 :: Only',
+    ],
+)