Merge pull request #28 from ami-iit/pypi

📦 Implement the pypeline to deploy the package to PyPI and TestPyPI

Author: GiulioRomualdi

.github/workflows/pypi-ci.yml

@@ -0,0 +1,85 @@
+name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+
+on:
+  push:
+    branches: [ '**' ]
+    tags-ignore: [ '**' ]
+  pull_request:
+  release:
+    types:
+      - published
+jobs:
+
+  build_wheels:
+    name: Build wheels [${{ matrix.os }}]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - 3.8
+        os:
+          - ubuntu-20.04
+          # - macos-latest
+          # - windows-latest
+
+    steps:
+
+      - uses: actions/checkout@master
+      - run: git fetch --prune --unshallow
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install pypa/build
+        run: pip install build
+
+      - name: Build wheel and a source tarball
+        run: python -m build --sdist --wheel --outdir dist/ .
+
+      - name: Archive artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: dist
+          path: dist
+
+
+  deploy_test_PyPI:
+    name: 📦 Deploy to TestPyPI
+    runs-on: ubuntu-20.04
+    needs: [build_wheels]
+    if: github.ref == 'refs/heads/main'
+    steps:
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish distribution 📦 to Test PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository_url: https://test.pypi.org/legacy/
+
+
+  deploy_PyPI:
+    name: 📦 Deploy to PyPI
+    runs-on: ubuntu-20.04
+    needs: [build_wheels]
+    if: startsWith(github.ref, 'refs/tags')
+    steps:
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -14,9 +14,7 @@ sudo apt install python3.8 python3-virtualenv swig
 Clone the repo and install the library:
 
 ```console
-git clone https://github.com/ami-iit/robot-log-visualizer.git
-cd robot-log-visualizer
-pip install .
+pip install robot-log-visualizer
 ```
 
 preferably in a [virtual environment](https://docs.python.org/3/library/venv.html#venv-def). For example:
@@ -26,6 +24,13 @@ python3 -m venv visualizer-env
 . visualizer-env/bin/activate
 ```
 
+### 👷 Install latest version (not recommended)
+If you want to use the latest feature of the `robot-log-visualizer` you can install it with the
+following command
+```console
+python -m pip install git+https://github.com/ami-iit/robot-log-visualizer.git
+```
+
 ## 🏃 Example
 
 Once you have install the `robot-log-visualizer` you can run it from the terminal