Db monitor

.gitignore

@@ -4,4 +4,6 @@
 utils/config.json
 build/
 dist/
-jwql.egg-info/
+jwql.egg-info/
+docs/build/
+docs/source/api/

README.md

@@ -73,7 +73,7 @@ The following is a bare bones example of a best work flow for contributing to th
 10. Delete your local copy of your branch.
 
 
-## Git Ignore
+## `gitignore`
 
 The `jwql` repository also contains a file named `.gitignore` that indicates specific directories, files or file types that should not be commited to the repository.  Feel free to add additional lines to this file if you want to avoid committing anything.  Some examples may include `.fits` files, `.jpeg` files, or `.ipynb_checkpoints/`.
 
@@ -86,7 +86,7 @@ Any questions about the `jwql` project or its software can be directed to `jwql@
 - Matthew Bourque (INS)
 - Lauren Chambers (INS)
 - Misty Cracraft (INS)
-- Joseph Filippazo (INS)
+- Joe Filippazzo (INS)
 - Bryan Hilbert (INS)
 - Graham Kanarek (INS)
 - Catherine Martlin (INS)
@@ -109,6 +109,7 @@ Any questions about the `jwql` project or its software can be directed to `jwql@
 - Phil Grant (ITSD)
 - Dean Hines (INS)
 - Sherrie Holfeltz (INS)
+- Joe Hunkeler (OED)
 - Catherine Kaleida (OED)
 - Mark Kyprianou (OED)
 - Karen Levay (OED)
@@ -125,4 +126,5 @@ Any questions about the `jwql` project or its software can be directed to `jwql@
 - Linda Smith (INS)
 - Dave Unger (ITSD)
 - Jeff Valenti (INS)
+- Lara Wilkinson (OPO)
 - Joe Zahn (ITSD)

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = jwql
+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
+
+# 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/source/api_docs.rst

@@ -0,0 +1,7 @@
+Preview Image Test
+==================
+.. automodapi:: jwql.preview_image.preview_image
+
+Utils Test
+==========
+.. automodapi:: jwql.utils.utils

docs/source/conf.py

@@ -0,0 +1,173 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# jwql documentation build configuration file, created by
+# sphinx-quickstart on Wed Apr  4 10:30:20 2018.
+#
+# 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
+# sys.path.insert(0, os.path.abspath('.'))
+import stsci_rtd_theme
+
+# -- 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_automodapi.automodapi',
+              'sphinx_automodapi.automodsumm',
+              'numpydoc',
+              'sphinx.ext.autodoc',
+              'sphinx.ext.mathjax',
+              'sphinx.ext.viewcode']
+
+# 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'
+
+# Numpy doc setting, right now this supresses some warnings, not exactly sure why?
+numpydoc_show_class_members = False
+
+# General information about the project.
+project = 'jwql'
+copyright = '2018, STScI'
+author = 'STScI'
+
+# 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 = '0.4.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.4.1'
+
+# 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 = False
+
+
+# -- 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 = 'stsci_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']
+html_theme_path = [stsci_rtd_theme.get_html_theme_path()]
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+#html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'jwqldoc'
+
+
+# -- 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, 'jwql.tex', 'jwql Documentation',
+     'STScI', '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, 'jwql', 'jwql 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, 'jwql', 'jwql Documentation',
+     author, 'jwql', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/source/index.rst

@@ -0,0 +1,30 @@
+.. jwql documentation master file, created by
+   sphinx-quickstart on Wed Apr  4 10:30:20 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to jwql's documentation!
+================================
+
+General JWQL description here.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+API documentation
+=================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   api_docs.rst	     
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

environment.yml

@@ -4,14 +4,19 @@ channels:
 - http://ssb.stsci.edu/astroconda-dev
 dependencies:
 - astropy=3.0
+- astroquery=0.3.8
+- bokeh=0.12.5
 - django=1.11.8
 - jwst=0.7.8rc9
 - matplotlib=2.1.1
 - numpy=1.14.0
+- numpydoc=0.8.0
 - postgresql=9.6.6
 - python=3.6.4
 - python-dateutil=2.6.1
 - sphinx=1.6.6
+- sphinx_rtd_theme=0.1.9
 - sqlalchemy=1.2.0
+- stsci_rtd_theme=0.0.1
 - pip:
   - sphinx-automodapi==0.7

jwql/__init__.py

@@ -0,0 +1 @@
+from . import dbmonitor