Skip to content

Commit

Permalink
Merge pull request #1659 from kbase/develop
Browse files Browse the repository at this point in the history
Merge to master to release the changes to support EE2
  • Loading branch information
briehl authored May 27, 2020
2 parents c0e18b6 + 99a13f8 commit 1e615d0
Show file tree
Hide file tree
Showing 103 changed files with 6,229 additions and 5,802 deletions.
2 changes: 1 addition & 1 deletion .eslintrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ env:
amd: true
extends: 'eslint:recommended'
parserOptions:
ecmaVersion: 5
ecmaVersion: 6
rules:
strict:
- error
Expand Down
10 changes: 5 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
dist: trusty
dist: bionic
sudo: required
language: python
python:
Expand Down Expand Up @@ -45,10 +45,10 @@ install:
- conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION
- source activate test-environment

before_script:
- "export DISPLAY=:99.0"
- "sh -e /etc/init.d/xvfb start"
- sleep 3 # give xvfb some time to start
# before_script:
# - "export DISPLAY=:99.0"
# - "sh -e /etc/init.d/xvfb start"
# - sleep 3 # give xvfb some time to start

script:
- make build-travis-narrative
Expand Down
9 changes: 5 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ REPO_NAME = narrative

# Installer script
INSTALLER = ./scripts/install_narrative.sh
INSTALL_VENV = narrative-venv
BACKEND_TEST_SCRIPT = scripts/narrative_backend_tests.sh
FRONTEND_TEST_DIR = test

Expand All @@ -18,12 +17,14 @@ build-narrative-container:
docker_image: build-narrative-container

# Per PR #1328, adding an option to skip minification
dev_image:
dev-image:
SKIP_MINIFY=1 DOCKER_TAG=dev sh $(DOCKER_INSTALLER)

run-dev-image:
ENV=$(ENV) bash scripts/local-dev-run.sh

install:
@echo "Installing local Narrative in the $(INSTALL_VENV) virtual environment"
bash $(INSTALLER) -v $(INSTALL_VENV)
bash $(INSTALLER)

# runs the installer to locally build the Narrative in a
# local venv.
Expand Down
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,17 @@ conda activate my_narrative_environment
./scripts/install_narrative.sh
kbase-narrative
```
If the previous instructions do not work, try
```
# source ~/anaconda3/bin/activate or wherever you have python installed
conda create -n my_narrative_environment
conda activate my_narrative_environment
sh scripts/install_narrative.sh
# scripts/install_narrative.sh
kbase-narrative
```



### Or, without conda - this installs lots of requirements of specific versions and may clobber things on your PYTHONPATH.
```
Expand Down Expand Up @@ -81,6 +92,16 @@ To run authenticated tests, you'll need to get an auth token from KBase servers,

Note: **DO NOT CHECK YOUR TOKEN FILE IN TO GITHUB**. You'll be shamed without mercy.

## Manual Testing

* It can be useful to immediately see your changes in the narrative. For javascript changes, you will just have to reload the page. You can print messages to the console with `console.log`

* For python changes, it will require shutting down the notebook, running `scripts/install_narrative.sh -u` and then starting the notebook server up again with kbase-narrative. You can print messages to the terminal using

```
log = logging.getLogger("tornado.application")
log.info("Your Logs Go Here")
```

## Submitting code

Expand Down
11 changes: 10 additions & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,17 @@ The Narrative Interface allows users to craft KBase Narratives using a combinati

This is built on the Jupyter Notebook v6.0.2 (more notes will follow).

### Version 4.2.0
- Updated the Narrative interface to connect to the remade Execution Engine.
- Updated the Narrative interface to streamline events and cookies connected to the Traefik update.
- Fixed an issue where job log browser state (running, stopped, scrolling) could cross browser sessions.
- Added a viewer for the SampleSet object.
- PTV-1446 - fix bug preventing KBaseFeatureValues viewer apps from working and displaying data

### Version 4.1.2
- Redirect to the interstitial loading page after shutting down a Narrative session, instead of letting the backend server do the redirect.
- Improve display of job logs.
- Prevent App cell elements from overflowing the page.
- Job status is now inaccessible before a job enters the queue.

### Version 4.1.1
- Fix sort order in Narratives panel - should be by most recently saved.
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "kbase-narrative",
"version": "4.1.2",
"version": "4.2.0",
"homepage": "https://kbase.us",
"dependencies": {
"bluebird": "3.4.7",
Expand Down
20 changes: 20 additions & 0 deletions docs/design/app-cells/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Flow and Modules

## 1. nbextensions
### Jupyter Notebook extensions
< blurb about Jupyter Notebook extensions here and what we're doing >

### App Cell extension pattern
Detection
Initialization
Cell transformation

## 2. App Cell Widget as controller
Main controller
Finite State Machine

## 3. App Cell Tabs

### A. Configure Tab

### B. Job Status Tab
Loading

0 comments on commit 1e615d0

Please sign in to comment.