Merge remote-tracking branch 'origin/master' into devel

.github/workflows/deploy_docs.yml

@@ -0,0 +1,24 @@
+name: deploy_docs
+on:
+  push:
+    branches:
+      - 'master'
+    paths:
+      - docs/**
+      - README.md
+      - mkdocs.yml
+      - catflow/**
+      - .github/workflows/deploy_docs.yml
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.10'
+      - uses: abatilo/[email protected]
+        with:
+          poetry-version: '1.3.0'
+      - run: poetry install --no-interaction --without test
+      - run: poetry run mkdocs gh-deploy --force

.github/workflows/release.yml

@@ -0,0 +1,21 @@
+name: Build and publish python package
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  publish-service-client-package:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build and publish to pypi
+        uses: JRubics/[email protected]
+        with:
+          python_version: ${{ matrix.python-version }}
+          poetry_version: "==1.3.0"
+          pypi_token: ${{ secrets.PYPI_API_TOKEN }}
+          plugins: "poetry-dynamic-versioning-plugin"

README.md

@@ -1,5 +1,7 @@
 # CatFlow
 
+> Parts of the code to be open source.
+
 [![Python package](https://github.com/Cloudac7/CatFlow/actions/workflows/ci.yml/badge.svg)](https://github.com/Cloudac7/CatFlow/actions/workflows/ci.yml)
 [![Coverage Status](https://coveralls.io/repos/github/Cloudac7/CatFlow/badge.svg?branch=master)](https://coveralls.io/github/Cloudac7/CatFlow?branch=master)
 
@@ -19,7 +21,7 @@ As is known to all, cat is fluid and thus cat flows. 🐱
 To install, clone the repository:
 
 ```
-git clone https://github.com/cloudac7/catflow.git
+git clone https://github.com/chenggroup/catflow.git
 ```
 
 and then install with `pip`: