[Release] Initial python-mano-wrapper release

+ Added docstrings for sphinx support
+ Minor changes to test cases
+ Minor bug fixes to make it unified
+ Added Sphinx documentation support
+ Added pypi support

.gitignore

@@ -214,3 +214,5 @@ fabric.properties
 
 */.vscode/settings.json
 
+src/adaptor/docs/doc
+src/adaptor/docs/doclatex

src/adaptor/docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx3-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)

src/adaptor/docs/conf.py

@@ -0,0 +1,178 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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('../../adaptor'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = u'Python Mano Wrappers'
+copyright = u'2019, Ashwin, Bhargavi, Deeksha'
+author = u'Ashwin, Bhargavi, Deeksha'
+
+# The short X.Y version
+version = u''
+# The full version, including alpha/beta/rc tags
+release = u''
+
+
+# -- 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.autodoc',
+    'sphinx.ext.githubpages',
+]
+
+# 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'
+
+# 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 pattern also affects html_static_path and html_extra_path.
+exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- 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 = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'PythonManoWrappersdoc'
+
+
+# -- 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, 'PythonManoWrappers.tex', u'Python Mano Wrappers Documentation',
+     u'Ashwin, Bhargavi, Deeksha', '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, 'pythonmanowrappers', u'Python Mano Wrappers 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, 'PythonManoWrappers', u'Python Mano Wrappers Documentation',
+     author, 'PythonManoWrappers', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------

src/adaptor/docs/index.rst

@@ -0,0 +1,62 @@
+.. Python Mano Wrappers documentation master file, created by
+   sphinx-quickstart on Sat Apr 13 18:13:38 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Python MANO Wrappers Documentation
+================================================
+
+Python MANO Wrappers (PMW) is a python wrapper around the REST API
+calls of various MANOs. It is also a standardisation effort to 
+unify the REST API of various MANOs by enforcing the ETSI SOL005 standard 
+on API calls. This project is developed as part of the project group SCrAMbLE
+at the University of Paderborn for the 5G-PICTURE project.  
+
+PMW can be installed using pip by using the following command 
+
+.. code-block:: bash
+    
+    pip install python-mano-wrappers
+
+
+PMW is easy to use and well documented. Code usage examples are available
+along with the function documentation.
+
+**Example usage:**
+
+.. code-block:: bash
+    
+    import wrappers
+
+    username = "admin"
+    password = "admin"
+    mano = "osm"
+    # mano = "sonata"
+    host = "vm-hadik3r-05.cs.uni-paderborn.de"
+
+    if mano == "osm":
+        _client = wrappers.OSMClient.Auth(host)
+    elif mano == "sonata":
+        _client = wrappers.SONATAClient.Auth(host)
+
+    response = _client.auth(
+                username=username, password=password)
+
+    print(response)
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Contents
+==================
+
+.. toctree::
+
+    wrappers.CommonInterface
+    wrappers.OSMClient
+    wrappers.SONATAClient
+

src/adaptor/docs/usefulCommands.md

@@ -0,0 +1,28 @@
++ To generate wheels
+
+python3 setup.py sdist bdist_wheel
+
++ To upload to pypi
+
+twine upload dist/*
+
++ add pypi details
+
+nano ~/.pypirc
+
+[distutils]
+index-servers =
+    pypi
+
+[pypi]
+repository: https://test.pypi.org/legacy/
+username: test-pgscramble
+password: 
+
++ To clean build files
+
+python3 setup.py clean --all
+
++ To build sphinx document
+
+sphinx-build -b html . ./doc

src/adaptor/docs/wrappers.CommonInterface.rst

@@ -0,0 +1,52 @@
+wrappers\.CommonInterface package
+=================================
+
+wrappers\.CommonInterface\.auth 
+--------------------------------------
+
+.. automodule:: wrappers.CommonInterface.auth
+    :members:
+    :show-inheritance:
+
+wrappers\.CommonInterface\.nsd 
+-------------------------------------
+
+.. automodule:: wrappers.CommonInterface.nsd
+    :members:
+    :show-inheritance:
+
+wrappers\.CommonInterface\.nsfm 
+--------------------------------------
+
+.. automodule:: wrappers.CommonInterface.nsfm
+    :members:
+    :show-inheritance:
+
+wrappers\.CommonInterface\.nslcm 
+---------------------------------------
+
+.. automodule:: wrappers.CommonInterface.nslcm
+    :members:
+    :show-inheritance:
+
+wrappers\.CommonInterface\.nspm 
+--------------------------------------
+
+.. automodule:: wrappers.CommonInterface.nspm
+    :members:
+    :show-inheritance:
+
+wrappers\.CommonInterface\.sonpackage 
+--------------------------------------------
+
+.. automodule:: wrappers.CommonInterface.sonpackage
+    :members:
+    :show-inheritance:
+
+wrappers\.CommonInterface\.vnfpkgm 
+-----------------------------------------
+
+.. automodule:: wrappers.CommonInterface.vnfpkgm
+    :members:
+    :show-inheritance:
+