From 1ba834e7522e2f3e8be54f34ce731b39e7f5e1eb Mon Sep 17 00:00:00 2001 From: Paco Nathan Date: Thu, 10 Mar 2022 10:22:12 -0800 Subject: [PATCH] prep release, confirming #230 --- README.md | 52 ++++++++++++++++++++++++++++-------------------- changelog.txt | 16 ++++++++++++++- docs/ack.md | 1 + kglab/version.py | 2 +- 4 files changed, 47 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index cbc3e63..b1df7b1 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ python3 -m pip install kglab If you work directly from this Git repo, be sure to install the dependencies: ```bash +python3 -m pip install -U pip python3 -m pip install -r requirements.txt ``` @@ -89,13 +90,25 @@ graph libraries in Python:
- Contributing Code + Using Docker -We welcome people getting involved as contributors to this open source -project! +For a simple approach to running the tutorials, see use of _docker compose_: + -For detailed instructions please see: -[CONTRIBUTING.md](https://github.com/DerwenAI/kglab/blob/main/CONTRIBUTING.md) +Also, container images for each release are available on DockerHub: + + +To build a container image and run it for the tutorials: +```bash +docker build --pull --rm -f "docker/Dockerfile" -t kglab:latest . +docker run -p 8888:8888 -it kglab +``` + +To build and run a container image for testing: +```bash +docker build --pull --rm -f "docker/testsuite.Dockerfile" -t kglabtest:latest . +docker run --rm -it kglabtest +```
@@ -117,23 +130,6 @@ section of the online documentation. -
- Using Docker - -To build a container image and run it for the tutorials: -```bash -docker build --pull --rm -f "docker/Dockerfile" -t kglab:latest . -docker run -p 8888:8888 -it kglab -``` - -To build and run a container image for testing: -```bash -docker build --pull --rm -f "docker/testsuite.Dockerfile" -t kglabtest:latest . -docker run --rm -it kglabtest -``` -
- -
Semantic Versioning @@ -149,6 +145,17 @@ See:
+
+ Contributing Code + +We welcome people getting involved as contributors to this open source +project! + +For detailed instructions please see: +[CONTRIBUTING.md](https://github.com/DerwenAI/kglab/blob/main/CONTRIBUTING.md) +
+ +