Skip to content

Commit e01f64a

Browse files
authored
Merge pull request #233 from DerwenAI/confirm_dockerhub
prep release, confirming #230
2 parents fc7ee57 + 1ba834e commit e01f64a

File tree

4 files changed

+47
-24
lines changed

4 files changed

+47
-24
lines changed

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ python3 -m pip install kglab
4444
If you work directly from this Git repo, be sure to install the
4545
dependencies:
4646
```bash
47+
python3 -m pip install -U pip
4748
python3 -m pip install -r requirements.txt
4849
```
4950

@@ -89,13 +90,25 @@ graph libraries in Python:
8990
9091

9192
<details>
92-
<summary>Contributing Code</summary>
93+
<summary>Using Docker</summary>
9394

94-
We welcome people getting involved as contributors to this open source
95-
project!
95+
For a simple approach to running the tutorials, see use of _docker compose_:
96+
<https://derwen.ai/docs/kgl/tutorial/#use-docker-compose>
9697

97-
For detailed instructions please see:
98-
[CONTRIBUTING.md](https://github.com/DerwenAI/kglab/blob/main/CONTRIBUTING.md)
98+
Also, container images for each release are available on DockerHub:
99+
<https://hub.docker.com/repository/docker/derwenai/kglab>
100+
101+
To build a container image and run it for the tutorials:
102+
```bash
103+
docker build --pull --rm -f "docker/Dockerfile" -t kglab:latest .
104+
docker run -p 8888:8888 -it kglab
105+
```
106+
107+
To build and run a container image for testing:
108+
```bash
109+
docker build --pull --rm -f "docker/testsuite.Dockerfile" -t kglabtest:latest .
110+
docker run --rm -it kglabtest
111+
```
99112
</details>
100113

101114

@@ -117,23 +130,6 @@ section of the online documentation.
117130
</details>
118131

119132

120-
<details>
121-
<summary>Using Docker</summary>
122-
123-
To build a container image and run it for the tutorials:
124-
```bash
125-
docker build --pull --rm -f "docker/Dockerfile" -t kglab:latest .
126-
docker run -p 8888:8888 -it kglab
127-
```
128-
129-
To build and run a container image for testing:
130-
```bash
131-
docker build --pull --rm -f "docker/testsuite.Dockerfile" -t kglabtest:latest .
132-
docker run --rm -it kglabtest
133-
```
134-
</details>
135-
136-
137133
<details>
138134
<summary>Semantic Versioning</summary>
139135

@@ -149,6 +145,17 @@ See:
149145
</details>
150146

151147

148+
<details>
149+
<summary>Contributing Code</summary>
150+
151+
We welcome people getting involved as contributors to this open source
152+
project!
153+
154+
For detailed instructions please see:
155+
[CONTRIBUTING.md](https://github.com/DerwenAI/kglab/blob/main/CONTRIBUTING.md)
156+
</details>
157+
158+
152159
<img
153160
alt="illustration of a knowledge graph, plus laboratory glassware"
154161
src="https://github.com/raw/DerwenAI/kglab/main/docs/assets/logo.png"
@@ -194,6 +201,7 @@ and to our contributors:
194201
[@louisguitton](https://github.com/louisguitton),
195202
[@tomaarsen](https://github.com/tomaarsen),
196203
[@Mec-iS](https://github.com/Mec-iS),
204+
[@RishiKumarRay](https://github.com/RishiKumarRay),
197205
[@ArenasGuerreroJulian](https://github.com/ArenasGuerreroJulian),
198206
[@fils](https://github.com/fils),
199207
[@gauravjaglan](https://github.com/gauravjaglan),

changelog.txt

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
# `kglab` changelog
22

3-
## 0.5.0
3+
## 0.5.?
44

55
2022-03-??
66

7+
* ???
8+
9+
10+
## 0.5.1
11+
12+
2022-03-10
13+
14+
* CI action to build/push container image to DockerHub on release; kudos @RishiKumarRay
15+
16+
17+
## 0.5.0
18+
19+
2022-03-08
20+
721
* improve Dockerfile (e.g., for use in regulated environments)
822
* refactor tutorial dependencies out of library
923
* remove dependency on PyTorch

docs/ack.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ and to our contributors:
1111
[@louisguitton](https://github.com/louisguitton),
1212
[@tomaarsen](https://github.com/tomaarsen),
1313
[@Mec-iS](https://github.com/Mec-iS),
14+
[@RishiKumarRay](https://github.com/RishiKumarRay),
1415
[@ArenasGuerreroJulian](https://github.com/ArenasGuerreroJulian),
1516
[@fils](https://github.com/fils),
1617
[@gauravjaglan](https://github.com/gauravjaglan),

kglab/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212

1313
MIN_PY_VERSION: typing.Tuple = (3, 7,)
14-
__version__: str = "0.5.0"
14+
__version__: str = "0.5.1"
1515

1616

1717
def _versify (

0 commit comments

Comments
 (0)