Added optional welcome cell to create_new_narrative

.dockerignore

@@ -1,2 +1,3 @@
 test_local
 sdk.cfg
+data

Dockerfile

@@ -5,8 +5,8 @@ MAINTAINER KBase Developer
 # Insert apt-get instructions here to install
 # any required dependencies for your module.
 
-# RUN apt-get update
-
+RUN apt-get update
+RUN apt-get install -y python-coverage
 # -----------------------------------------
 
 COPY ./ /kb/module

Makefile

@@ -55,7 +55,8 @@ build-test-script:
 	echo 'export KB_AUTH_TOKEN=`cat /kb/module/work/token`' >> $(TEST_DIR)/$(TEST_SCRIPT_NAME)
 	echo 'export PYTHONPATH=$$script_dir/../$(LIB_DIR):$$PATH:$$PYTHONPATH' >> $(TEST_DIR)/$(TEST_SCRIPT_NAME)
 	echo 'cd $$script_dir/../$(TEST_DIR)' >> $(TEST_DIR)/$(TEST_SCRIPT_NAME)
-	echo 'python -u -m unittest discover -p "*_test.py"' >> $(TEST_DIR)/$(TEST_SCRIPT_NAME)
+	# echo 'python -u -m unittest discover -p "*_test.py"' >> $(TEST_DIR)/$(TEST_SCRIPT_NAME)
+	echo 'python -m nose --with-coverage --cover-package=NarrativeService --cover-html --cover-html-dir=/kb/module/work/cover_html .' >> $(TEST_DIR)/$(TEST_SCRIPT_NAME)
 	chmod +x $(TEST_DIR)/$(TEST_SCRIPT_NAME)
 
 test:
@@ -69,3 +70,7 @@ install-clients:
 	kb-sdk install -c https://raw.githubusercontent.com/kbase/workspace_deluxe/master/workspace.spec
 	kb-sdk install -c https://raw.githubusercontent.com/kbase/narrative_method_store/develop/NarrativeMethodStore.spec
 	kb-sdk install -d https://raw.githubusercontent.com/kbaseapps/DataPaletteService/master/DataPaletteService.spec
+
+ref-data:
+	cp -a ./data/* /data/
+	touch /data/__READY__

NarrativeService.spec

@@ -4,8 +4,10 @@ A KBase module: NarrativeService
 
 module NarrativeService {
 
+    /* @range [0,1] */
+    typedef int boolean;
 
-    /* 
+    /*
         A time in the format YYYY-MM-DDThh:mm:ssZ, where Z is either the
         character Z (representing the UTC timezone) or the difference
         in time to UTC in the format +/-HHMM, eg:
@@ -16,7 +18,7 @@ module NarrativeService {
     typedef string timestamp;
 
     /* Represents the permissions a user or users have to a workspace:
-        
+
         'a' - administrator. All operations allowed.
         'w' - read/write.
         'r' - read.
@@ -30,7 +32,7 @@ module NarrativeService {
     typedef string lock_status;
 
     /* Information about an object, including user provided metadata.
-        
+
         obj_id objid - the numerical id of the object.
         obj_name name - the name of the object.
         type_string type - the type of the object.
@@ -92,7 +94,7 @@ module NarrativeService {
         returns (ListObjectsWithSetsOutput) authentication required;
 
     /*
-        workspaceId - optional workspace ID, if not specified then 
+        workspaceId - optional workspace ID, if not specified then
             property from workspaceRef object info is used.
     */
     typedef structure {
@@ -187,6 +189,7 @@ module NarrativeService {
         markdown - markdown text for cell of 'markdown' type (optional)
         copydata - packed inport data in format "import(;...)*" (alternative to importData)
         importData - import data in unpacked form (alternative to copydata)
+        includeIntroCell - if 1, adds an introductory markdown cell at the top (optional, default 0)
     */
     typedef structure {
         string app;
@@ -196,13 +199,14 @@ module NarrativeService {
         string markdown;
         string copydata;
         list<string> importData;
+        boolean includeIntroCell;
     } CreateNewNarrativeParams;
-    
+
     typedef structure {
         WorkspaceInfo workspaceInfo;
-        ObjectInfo objectInfo;
+        ObjectInfo narrativeInfo;
     } CreateNewNarrativeOutput;
-    
+
     funcdef create_new_narrative(CreateNewNarrativeParams params)
         returns (CreateNewNarrativeOutput) authentication required;
 
@@ -227,7 +231,7 @@ module NarrativeService {
         ObjectInfo info;
     } CopyObjectOutput;
 
-    funcdef copy_object(CopyObjectParams params) 
+    funcdef copy_object(CopyObjectParams params)
         returns (CopyObjectOutput) authentication required;
 
 

data/welcome-cell-content.md

@@ -0,0 +1,39 @@
+![KBase Logo](/images/kbase-logo-web.png)
+# Welcome to the Narrative Interface!
+
+## What's a Narrative?
+In KBase, you can customize and execute a series of analysis steps to create shareable, reproducible “Narratives” that include data, analysis steps, results, visualizations and commentary.
+
+[learn more...]({{config.resources.docSite.base.url}}/narrative-guide)
+
+## Get Some Data
+Click the Add Data button in the Data Panel to browse for KBase data or
+upload your own. Mouse over a data object to add it to your Narrative, and
+check out more details once the data appears in your list.
+
+[learn more...]({{config.resources.docSite.base.url}}/narrative-guide/explore-data)
+
+## Analyze It
+Browse available analyses that can be run using KBase apps. Select an app, fill in the fields, and click Run.
+Output will be generated, and new data objects may be created and added
+to your data list.
+
+[learn more...]({{config.resources.docSite.base.url}}/narrative-guide/browse-apps-and-methods)
+
+## Save and Share Your Narrative
+Be sure to save your Narrative frequently. When you're ready, click the share button above to let collaborators view your analysis steps
+and results. Or better yet, make your Narrative public and help expand
+the social web that KBase is building to make systems biology research
+more open, reproducible and collaborative.
+
+[learn more...]({{config.resources.docSite.base.url}}/narrative-guide/share-narratives/)
+
+## Find Documentation and Help
+For more information, please see the
+[Narrative Interface User Guide]({{config.resources.docSite.base.url}}/narrative-guide)
+or the [tutorials]({{config.resources.docSite.base.url}}/tutorials).
+
+Questions? [Contact us]({{config.resources.docSite.base.url}}/contact-us)!
+
+Ready to begin adding to your Narrative? You can keep this Welcome cell or
+delete it by selecting "Delete cell" from the "..." menu in the top right corner of this cell.

deploy.cfg

@@ -9,3 +9,4 @@ narrative-method-store = {{ kbase_endpoint }}/narrative_method_store/rpc
 setapi-version = dev
 datapaletteservice-version = dev
 scratch = /kb/module/work/tmp
+intro-markdown-file = /data/welcome-cell-content.md

kbase.yml

@@ -14,4 +14,7 @@ owners:
     [rsutormin, msneddon, wjriehl]
 
 service-config:
-    dynamic-service: true
+    dynamic-service: true
+
+data-version:
+    1.0