Skip to content

Commit 775450f

Browse files
committed
update docs for pori_python and update the required libraries
1 parent 3e2e4f7 commit 775450f

File tree

7 files changed

+24
-120
lines changed

7 files changed

+24
-120
lines changed

docker-compose.dev.yml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,8 @@ services:
3636
networks:
3737
- app-network
3838
volumes:
39-
- source: ./databases/orientdb/data
40-
target: /orientdb/databases
41-
type: bind
42-
- source: ./databases/orientdb/backup
43-
target: /orientdb/backup
44-
type: bind
45-
user: "${UID}:${GID}"
39+
- orientdb_data:/orientdb/databases
40+
- orientdb_backup:/orientdb/backup
4641
graphkb_api:
4742
image: bcgsc/pori-graphkb-api:latest
4843
ports:
@@ -140,7 +135,7 @@ services:
140135
image: bcgsc/pori-ipr-api:latest
141136
command: npm start
142137
ports:
143-
- 8082:8082
138+
- 8082:8080
144139
environment:
145140
IPR_DATABASE_HOSTNAME: ipr_db
146141
IPR_DATABASE_NAME: ipr_demo
@@ -191,3 +186,6 @@ services:
191186
networks:
192187
app-network:
193188
driver: bridge
189+
volumes:
190+
orientdb_data:
191+
orientdb_backup:

docs/build_external.sh

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,15 @@
44
# clone the IPR python adapter if it does not exist, otherwise update
55
if ! [ -d docs/_pori_ipr_python ];
66
then
7-
git clone https://github.com/bcgsc/pori_ipr_python.git docs/_pori_ipr_python
8-
echo "hide: true" > docs/_pori_ipr_python/.pages
7+
git clone https://github.com/bcgsc/pori_python.git docs/_pori_python
8+
echo "hide: true" > docs/_pori_python/.pages
99
else
10-
cd docs/_pori_ipr_python
10+
cd docs/_pori_python
1111
git checkout master
1212
git pull
1313
cd ../..
1414
fi
1515

16-
# clone the GraphKB Python adapter if it does not exist, otherwise update
17-
if ! [ -d docs/_pori_graphkb_python ];
18-
then
19-
git clone https://github.com/bcgsc/pori_graphkb_python.git docs/_pori_graphkb_python
20-
echo "hide: true" > docs/_pori_graphkb_python/.pages
21-
else
22-
cd docs/_pori_graphkb_python
23-
git checkout master
24-
git pull
25-
cd ../..
26-
fi
27-
28-
2916
# clone the loaders repo if it does not exist, otherwise update
3017
if ! [ -d docs/graphkb/_pori_graphkb_loader ];
3118
then
@@ -40,8 +27,8 @@ fi
4027

4128
# now build the reference python module API files
4229
markdown_refdocs \
43-
docs/_pori_graphkb_python/graphkb \
44-
docs/_pori_ipr_python/ipr \
30+
docs/_pori_python/pori_python/graphkb \
31+
docs/_pori_python/pori_python/ipr \
4532
-o docs/developer_reference \
4633
--link
4734

docs/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ software designed to support scalable precision oncology. The platform has two m
55
a graph knowledge base ([GraphKB](./graphkb)) and an integrated pipeline reporting application ([IPR](./ipr)). This site
66
contains central documentation for the platform as well as setup and installation instructions.
77

8-
Click on the menu icon (:material-menu:) to see a full table of contents for this site.
98

109
![pori server stack](./images/pori-server-stack.png)
1110

docs/ipr_spec_tables.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def spec_to_md(spec, optional_only=False, ignore_nested=False):
7979
return result
8080

8181

82-
specfile = os.path.join(os.path.dirname(__file__), '_pori_ipr_python/ipr/content.spec.json')
82+
specfile = os.path.join(os.path.dirname(__file__), '_pori_python/pori_python/ipr/content.spec.json')
8383
with open(specfile, 'r') as fh:
8484
spec = json.load(fh)
8585

docs/repos.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,9 @@ A developer reference for these packages including the function signatures and p
7676

7777
<div class='projects' markdown='1'>
7878

79-
- ### [GraphKB Python Adapter](https://github.com/bcgsc/pori_graphkb_python)
79+
- ### [Pori Python Adapter](https://github.com/bcgsc/pori_python)
8080

81-
![graphkb python](./images/graph-icon_outline.svg)
82-
83-
Python adapter package for querying the GraphKB API. See the related
84-
[user manual](../graphkb/python/docs) for instructions on incorporating
85-
this into custom scripts.
86-
87-
- ### [IPR Python Adapter](https://github.com/bcgsc/pori_ipr_python)
88-
89-
![ipr python](./images/wrench.svg)
81+
![pori python](./images/wrench.svg)
9082

9183
Python adapter for generating reports uploaded to the IPR API. This python tool takes in variant inputs as tab-delimited files and annotates them using GraphKB. The resulting output is uploaded to IPR as a report. Additional report content such as images and metadata can be passed to be included in the report upload.
9284

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ markdown_extensions:
1818
check_paths: True
1919
base_path: .
2020
- pymdownx.emoji:
21-
emoji_index: !!python/name:materialx.emoji.twemoji
22-
emoji_generator: !!python/name:materialx.emoji.to_svg
21+
emoji_index: !!python/name:material.extensions.emoji.twemoji
22+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
2323
- attr_list
2424
- markdown_include.include:
2525
base_path: docs

requirements.txt

Lines changed: 8 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,9 @@
1-
appdirs==1.4.4
2-
async-generator==1.10
3-
attrs==21.2.0
4-
black==21.5b2
5-
bleach==3.3.0
6-
bracex==2.1.1
7-
certifi==2020.12.5
8-
chardet==4.0.0
9-
click==7.1.2
10-
defusedxml==0.7.1
11-
entrypoints==0.3
12-
future==0.18.2
13-
ghp-import==2.0.2
14-
gitdb==4.0.7
15-
GitPython==3.1.17
16-
graphkb==1.5.4
17-
idna==2.10
18-
importlib-metadata==4.10.1
19-
ipython-genutils==0.2.0
20-
Jinja2==2.11.3
21-
joblib==1.0.1
22-
jsonschema==3.2.0
23-
jupyter-client==6.2.0
24-
jupyter-core==4.7.1
25-
jupyterlab-pygments==0.1.2
26-
jupytext==1.11.2
27-
livereload==2.6.3
28-
lunr==0.5.8
29-
Markdown==3.3.4
30-
markdown-include==0.6.0
31-
markdown-it-py==1.1.0
32-
markdown-refdocs==1.4.0
33-
MarkupSafe==1.1.1
34-
mdit-py-plugins==0.2.8
35-
mergedeep==1.3.4
36-
mistune==0.8.4
37-
mkdocs==1.2.3
38-
mkdocs-awesome-pages-plugin==2.5.0
1+
mkdocs==1.6.1
2+
mkdocs-material==9.6.17
3+
markdown-include==0.8.1
394
mkdocs-exclude==1.0.2
40-
mkdocs-include-markdown-plugin==3.0.1
41-
mkdocs-material==8.1.8
42-
mkdocs-material-extensions==1.0.1
43-
mkdocs-redirects==1.0.3
44-
mknotebooks==0.7.0
45-
mypy==0.812
46-
mypy-extensions==0.4.3
47-
nbclient==0.5.3
48-
nbconvert==6.0.7
49-
nbformat==5.1.3
50-
nest-asyncio==1.5.1
51-
nltk==3.6.2
52-
packaging==20.9
53-
pandocfilters==1.4.3
54-
pathspec==0.8.1
55-
progressbar2==3.53.1
56-
Pygments==2.11.2
57-
pymdown-extensions==9.1
58-
pyparsing==2.4.7
59-
pyrsistent==0.17.3
60-
python-dateutil==2.8.1
61-
python-utils==2.5.6
62-
pytz==2021.1
63-
PyYAML==5.4.1
64-
pyyaml-env-tag==0.1
65-
pyzmq==22.1.0
66-
regex==2021.4.4
67-
requests==2.25.1
68-
six==1.15.0
69-
smmap==4.0.0
70-
testpath==0.5.0
71-
toml==0.10.2
72-
tornado==6.1
73-
tqdm==4.60.0
74-
traitlets==5.0.5
75-
typed-ast==1.4.3
76-
typing-extensions==3.7.4.3
77-
urllib3==1.26.5
78-
watchdog==2.1.6
79-
wcmatch==8.2
80-
webencodings==0.5.1
81-
zipp==3.4.1
5+
mkdocs-awesome-pages-plugin==2.10.1
6+
mkdocs-include-markdown-plugin==7.1.6
7+
mkdocs-redirects==1.2.2
8+
mknotebooks==0.8.0
9+
markdown_refdocs==1.4.1

0 commit comments

Comments
 (0)