Skip to content

Commit

Permalink
prep release, confirming #230
Browse files Browse the repository at this point in the history
  • Loading branch information
ceteri committed Mar 10, 2022
1 parent fc7ee57 commit 1ba834e
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 24 deletions.
52 changes: 30 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down Expand Up @@ -89,13 +90,25 @@ graph libraries in Python:

<details>
<summary>Contributing Code</summary>
<summary>Using Docker</summary>

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_:
<https://derwen.ai/docs/kgl/tutorial/#use-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:
<https://hub.docker.com/repository/docker/derwenai/kglab>

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
```
</details>


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


<details>
<summary>Using Docker</summary>

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
```
</details>


<details>
<summary>Semantic Versioning</summary>

Expand All @@ -149,6 +145,17 @@ See:
</details>


<details>
<summary>Contributing Code</summary>

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)
</details>


<img
alt="illustration of a knowledge graph, plus laboratory glassware"
src="https://raw.githubusercontent.com/DerwenAI/kglab/main/docs/assets/logo.png"
Expand Down Expand Up @@ -194,6 +201,7 @@ and to our contributors:
[@louisguitton](https://github.com/louisguitton),
[@tomaarsen](https://github.com/tomaarsen),
[@Mec-iS](https://github.com/Mec-iS),
[@RishiKumarRay](https://github.com/RishiKumarRay),
[@ArenasGuerreroJulian](https://github.com/ArenasGuerreroJulian),
[@fils](https://github.com/fils),
[@gauravjaglan](https://github.com/gauravjaglan),
Expand Down
16 changes: 15 additions & 1 deletion changelog.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
# `kglab` changelog

## 0.5.0
## 0.5.?

2022-03-??

* ???


## 0.5.1

2022-03-10

* CI action to build/push container image to DockerHub on release; kudos @RishiKumarRay


## 0.5.0

2022-03-08

* improve Dockerfile (e.g., for use in regulated environments)
* refactor tutorial dependencies out of library
* remove dependency on PyTorch
Expand Down
1 change: 1 addition & 0 deletions docs/ack.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ and to our contributors:
[@louisguitton](https://github.com/louisguitton),
[@tomaarsen](https://github.com/tomaarsen),
[@Mec-iS](https://github.com/Mec-iS),
[@RishiKumarRay](https://github.com/RishiKumarRay),
[@ArenasGuerreroJulian](https://github.com/ArenasGuerreroJulian),
[@fils](https://github.com/fils),
[@gauravjaglan](https://github.com/gauravjaglan),
Expand Down
2 changes: 1 addition & 1 deletion kglab/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@


MIN_PY_VERSION: typing.Tuple = (3, 7,)
__version__: str = "0.5.0"
__version__: str = "0.5.1"


def _versify (
Expand Down

0 comments on commit 1ba834e

Please sign in to comment.