Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python SDK cleanup #348

Merged
merged 5 commits into from
Dec 4, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions sdk/python/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@


def common_options(func):
"""
Options that are available for most CLI commands
"""
for option in reversed(_common_options):
func = option(func)
return func
Expand Down Expand Up @@ -62,10 +65,10 @@ def version(client_only: bool, **kwargs):
if not client_only:
feast_client = Client(
core_url=feast_config.get_config_property_or_fail(
"core_url", cli_config=kwargs
"core_url", force_config=kwargs
),
serving_url=feast_config.get_config_property_or_fail(
"serving_url", cli_config=kwargs
"serving_url", force_config=kwargs
),
)
feast_versions_dict.update(feast_client.version())
Expand All @@ -92,7 +95,7 @@ def config_list():
"""

try:
feast_config_string = toml.dumps(feast_config.get_or_create_config())
feast_config_string = toml.dumps(feast_config._get_or_create_config())
if not feast_config_string.strip():
print("Configuration has not been set")
else:
Expand Down
23 changes: 23 additions & 0 deletions sdk/python/docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = Feast
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 source

source:
sphinx-apidoc -f -o source ../feast

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile source
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
171 changes: 171 additions & 0 deletions sdk/python/docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
# -*- coding: utf-8 -*-
#
# Feast documentation build configuration file, created by
# sphinx-quickstart on Sat Nov 30 15:06:53 2019.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# 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 sphinx_rtd_theme


sys.path.insert(0, os.path.abspath("../feast"))


# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# 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.doctest",
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx.ext.coverage",
"sphinx.ext.mathjax",
"sphinx.ext.ifconfig",
"sphinx.ext.viewcode",
"sphinx.ext.githubpages",
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx_rtd_theme",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"

# The master toctree document.
master_doc = "index"

# General information about the project.
project = u"Feast"
copyright = u"2019, Feast Authors"
author = u"Feast Authors"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u"0.3.2"
# The full version, including alpha/beta/rc tags.
release = u"0.3.2"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True


# -- 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 = "sphinx_rtd_theme"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {"font_size": "15px"}

# 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"]


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = "Feastdoc"


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, "Feast.tex", u"Feast Documentation", u"Feast Authors", "manual")
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "feast", u"Feast Documentation", [author], 1)]


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc,
"Feast",
u"Feast Documentation",
author,
"Feast",
"One line description of project.",
"Miscellaneous",
)
]


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"https://docs.python.org/": None}
78 changes: 78 additions & 0 deletions sdk/python/docs/source/feast.core.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
feast.core package
==================

Submodules
----------

feast.core.CoreService\_pb2 module
----------------------------------

.. automodule:: feast.core.CoreService_pb2
:members:
:undoc-members:
:show-inheritance:

feast.core.CoreService\_pb2\_grpc module
----------------------------------------

.. automodule:: feast.core.CoreService_pb2_grpc
:members:
:undoc-members:
:show-inheritance:

feast.core.FeatureSet\_pb2 module
---------------------------------

.. automodule:: feast.core.FeatureSet_pb2
:members:
:undoc-members:
:show-inheritance:

feast.core.FeatureSet\_pb2\_grpc module
---------------------------------------

.. automodule:: feast.core.FeatureSet_pb2_grpc
:members:
:undoc-members:
:show-inheritance:

feast.core.Source\_pb2 module
-----------------------------

.. automodule:: feast.core.Source_pb2
:members:
:undoc-members:
:show-inheritance:

feast.core.Source\_pb2\_grpc module
-----------------------------------

.. automodule:: feast.core.Source_pb2_grpc
:members:
:undoc-members:
:show-inheritance:

feast.core.Store\_pb2 module
----------------------------

.. automodule:: feast.core.Store_pb2
:members:
:undoc-members:
:show-inheritance:

feast.core.Store\_pb2\_grpc module
----------------------------------

.. automodule:: feast.core.Store_pb2_grpc
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: feast.core
:members:
:undoc-members:
:show-inheritance:
38 changes: 38 additions & 0 deletions sdk/python/docs/source/feast.loaders.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
feast.loaders package
=====================

Submodules
----------

feast.loaders.file module
-------------------------

.. automodule:: feast.loaders.file
:members:
:undoc-members:
:show-inheritance:

feast.loaders.ingest module
---------------------------

.. automodule:: feast.loaders.ingest
:members:
:undoc-members:
:show-inheritance:

feast.loaders.yaml module
-------------------------

.. automodule:: feast.loaders.yaml
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: feast.loaders
:members:
:undoc-members:
:show-inheritance:
Loading