Merge pull request #50 from harshad16/coala-fixes

py linting and coala fixes

Reviewed-by: https://github.com/thoth-zuul[bot]

Author: thoth-zuul[bot]

.zuul.yaml

@@ -2,14 +2,14 @@
     check:
       jobs:
         - "thoth-coala"
-        - "thoth-pytest" 
+        - "thoth-pytest"
     gate:
       queue: "aicoe/prometheus"
       jobs:
         - "thoth-coala"
-        - "thoth-pytest" 
+        - "thoth-pytest"
     kebechet-auto-gate:
       queue: "aicoe/prometheus"
       jobs:
         - "thoth-coala"
-        - "thoth-pytest" 
+        - "thoth-pytest"

app.py

@@ -1,11 +1,19 @@
+"""Simple example application."""
 # Example Usage
 import prometheus_connect
-url="www.example-prom-url.com"
-token='Auth_token'
+
+url = "www.example-prom-url.com"
+token = "Auth_token"
 
 prom = prometheus_connect.PrometheusConnect(url=url, token=token)
 
-labels = {'pod':'prometheus-k8s-0', '_id': 'f716a8c8-5d4e-417a-a95c-742c2bbcd3d2'}
-metric_data = (prom.get_metric_range_data(metric_name='up', start_time='20m', label_config=labels, chunk_size='10m', store_locally=True))
+labels = {"pod": "prometheus-k8s-0", "_id": "f716a8c8-5d4e-417a-a95c-742c2bbcd3d2"}
+metric_data = prom.get_metric_range_data(
+    metric_name="up",
+    start_time="20m",
+    label_config=labels,
+    chunk_size="10m",
+    store_locally=True,
+)
 
 prom.pretty_print_metric(metric_data)

docs/conf.py

@@ -11,23 +11,24 @@
 # 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.
-#
+"""Configuration file for the Sphinx documentation builder."""
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('../'))
+
+sys.path.insert(0, os.path.abspath("."))
+sys.path.insert(0, os.path.abspath("../"))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'Prometheus Client API Python'
-copyright = '2019, Anand Sanmukhani'
-author = 'Anand Sanmukhani'
+project = "Prometheus Client API Python"
+copyright = "2019, Anand Sanmukhani"
+author = "Anand Sanmukhani"
 
 # The short X.Y version
-version = ''
+version = ""
 # The full version, including alpha/beta/rc tags
-release = '0.0.1'
+release = "0.0.1"
 
 
 # -- General configuration ---------------------------------------------------
@@ -40,26 +41,26 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.doctest',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+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'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -71,7 +72,7 @@
 # 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']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
@@ -82,7 +83,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+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
@@ -93,7 +94,7 @@
 # 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']
+html_static_path = ["_static"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -109,7 +110,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'PrometheusClientAPIPythondoc'
+htmlhelp_basename = "PrometheusClientAPIPythondoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -118,15 +119,12 @@
     # 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',
@@ -136,8 +134,13 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'PrometheusClientAPIPython.tex', 'Prometheus Client API Python Documentation',
-     'Anand Sanmukhani', 'manual'),
+    (
+        master_doc,
+        "PrometheusClientAPIPython.tex",
+        "Prometheus Client API Python Documentation",
+        "Anand Sanmukhani",
+        "manual",
+    )
 ]
 
 
@@ -146,8 +149,13 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'prometheusclientapipython', 'Prometheus Client API Python Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "prometheusclientapipython",
+        "Prometheus Client API Python Documentation",
+        [author],
+        1,
+    )
 ]
 
 
@@ -157,9 +165,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'PrometheusClientAPIPython', 'Prometheus Client API Python Documentation',
-     author, 'PrometheusClientAPIPython', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "PrometheusClientAPIPython",
+        "Prometheus Client API Python Documentation",
+        author,
+        "PrometheusClientAPIPython",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]
 
 
@@ -178,15 +192,15 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
 
 
 # -- Extension configuration -------------------------------------------------
 
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {"https://docs.python.org/": None}
 
 # -- Options for todo extension ----------------------------------------------
 

prometheus_api_client/__init__.py

@@ -1,4 +1,4 @@
-""" A Class for collection of metrics from a Prometheus Host """
+"""A Class for collection of metrics from a Prometheus Host."""
 
 __title__ = "prometheus-connect"
 __version__ = "0.0.1"