Full functionality for tarball-installed notebooker instances

Author: jonbannister

.circleci/config.yml

@@ -89,7 +89,7 @@ defaults: &defaults
          . ci/bin/activate
          pip install -e ".[prometheus]" ".[test]"
          python -m ipykernel install --user --name=notebooker_kernel
-         pip install -r ./notebook_templates/notebook_requirements.txt
+         pip install -r ./notebooker/notebook_templates_example/notebook_requirements.txt
          mkdir test-results
          pytest --junitxml=test-results/junit.xml
          # bash <(curl -s https://codecov.io/bash) -c -F python

MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include notebooker/web/templates *
+recursive-include notebooker/web/static *

docker/Dockerfile

@@ -22,7 +22,7 @@ WORKDIR /workspace
 RUN set -eux \
   ; pip install -e ".[prometheus]" ".[test]" \
   ; python -m ipykernel install --user --name=notebooker_kernel \
-  ; pip install -r ./notebook_templates/notebook_requirements.txt \
+  ; pip install -r ./notebooker/notebook_templates_example/notebook_requirements.txt \
   ; python setup.py develop \
   ; python setup.py build_sphinx \
   ; py.test tests \

notebooker/notebook_templates_example/README.md

@@ -0,0 +1,5 @@
+# README
+
+This is just an example of what the base of a notebooker templates 
+git repo should look like. `notebook_requirements.txt` should be
+specified and a hierarchy of templates added to modules and submodules.

notebook_templates/__init__.py renamed to notebooker/notebook_templates_example/__init__.py

@@ -74,7 +74,7 @@ def _get_python_template_path(report_path: str, warn_on_local: bool) -> str:
             logger.warning(
                 "Loading from notebooker default templates. This is only expected if you are running locally."
             )
-        return pkg_resources.resource_filename(__name__, "../../notebook_templates/{}.py".format(report_path))
+        return pkg_resources.resource_filename(__name__, "../notebook_templates_example/{}.py".format(report_path))
 
 
 def _get_output_path_hex() -> str:

notebook_templates/notebook_requirements.txt renamed to notebooker/notebook_templates_example/notebook_requirements.txt

@@ -49,9 +49,9 @@ def get_all_possible_templates(warn_on_local=True):
         if warn_on_local:
             logger.warning("Fetching all possible checks from local repo. New updates will not be retrieved from git.")
         # Only import here because we don't actually want to import these if the app is working properly.
-        import notebook_templates
+        from .. import notebook_templates_example
 
-        all_checks = get_directory_structure(os.path.abspath(notebook_templates.__path__[0]))
+        all_checks = get_directory_structure(os.path.abspath(notebook_templates_example.__path__[0]))
     return all_checks