🚀 publish python package (#109)

Author: momegas

.github/workflows/docs_publish.yml

@@ -1,8 +1,8 @@
 name: Publish docs
 on:
-  push:
-    branches:
-      - main
+  release:
+    types: [published]
+
 permissions:
   contents: write
 jobs:
@@ -12,6 +12,6 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
-      - run: pip install mkdocs-material 
+          python-version: "3.10"
+      - run: pip install mkdocs-material
       - run: mkdocs gh-deploy --config-file docs/mkdocs/mkdocs.yml --force

.github/workflows/release_pypi_package.yml

@@ -0,0 +1,42 @@
+name: Release PyPI Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release_package:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+
+      - name: Publish distribution 📦 to PyPI
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -12,4 +12,7 @@ check_data/
 *.db
 site/
 notebooks/
-test.ipynb
+test.ipynb
+dist/
+build/
+whitebox_sdk.egg-info

Dockerfile

@@ -12,4 +12,4 @@ COPY . .
 
 EXPOSE 8000
 
-ENTRYPOINT ENV=dev uvicorn src.main:app --reload --host 0.0.0.0 --port 8000 
+ENTRYPOINT ENV=dev uvicorn whitebox.main:app --reload --host 0.0.0.0 --port 8000 

README.md

@@ -37,19 +37,35 @@ Design guidelines:
 - **Robust**: Get production-ready MLOps system.
 - **Kubernetes**: Get production-ready code. With automatic interactive documentation.
 
-# How to use
+# Installation
+
+Install the SDK with `pip`:
 
-## Run the server
+```bash
+pip install whitebox-sdk
+```
 
-The project is still in rapid development so to run the server clone the repo and run:
+Install whitebox server and all of its dependencies in your k8s cluster using `helm`
 
 ```bash
-python -m venv .venv
-pip install -r requirements.txt
-ENV=dev uvicorn src.main:app --reload
+helm repo add squaredev https://chartmuseum.squaredev.io/
+helm repo update
+helm install whitebox squaredev/whitebox
+```
+
+# How to use
+
+After you are done installing the server and the SDK, you can start using it.
+
+After you get the API key, all you have to do is create an instance of the Whitebox class adding your host and API key as parameters:
+
+```python
+from whitebox import Whitebox
+
+wb = Whitebox(host="127.0.0.1:8000", api_key="some_api_key")
 ```
 
-In the near future you will be able to `pip install whitebox` and run `whitebox serve` to run whitebox.
+Now you're ready to start using Whitebox! Read the [documentation](https://squaredev-io.github.io/whitebox/) to learn more about the SDK.
 
 ## High level diagram of model set up
 
@@ -85,7 +101,7 @@ pre-commit install
 ### Run the server:
 
 ```bash
-ENV=dev uvicorn src.main:app --reload
+ENV=dev uvicorn whitebox.main:app --reload
 ```
 
 ### Tests:
@@ -103,15 +119,6 @@ ENV=dev uvicorn src.main:app --reload
 mkdocs serve -f docs/mkdocs/mkdocs.yml -a localhost:8001
 ```
 
-# Helm chart
-You can install whitebox and all of its dependencies in your k8s cluster using helm
-  
-  ```bash
-  helm repo add squaredev https://chartmuseum.squaredev.io/
-  helm repo update
-  helm install whitebox squaredev/whitebox
-  ```
-
 # Contributing
 
 We happily welcome contributions to Whitebox. You can start by opening a new issue!

pytest.ini

@@ -2,5 +2,5 @@
 pythonpath = .
 log_cli=true
 ; log_cli_level = "INFO"
-; addopts = --ignore=src/tests/v1/**.py
+; addopts = --ignore=whitebox/tests/v1/**.py
 markers = order

setup.py

@@ -0,0 +1,27 @@
+from setuptools import setup, find_packages
+import os
+
+# get version from env  variable
+VERSION = os.environ.get("VERSION")
+assert VERSION is not None, "VERSION env variable must be set"
+
+DESCRIPTION = "Whitebox is an open source E2E ML monitoring platform with edge capabilities that plays nicely with kubernetes"
+LONG_DESCRIPTION = ""
+
+# Setting up
+setup(
+    # the name must match the folder name 'verysimplemodule'
+    name="whitebox-sdk",
+    version=VERSION,
+    author="Squaredev",
+    author_email="hello@squaredev.io",
+    description=DESCRIPTION,
+    long_description=LONG_DESCRIPTION,
+    packages=find_packages(),
+    install_requires=[],  # add any additional packages that
+    # needs to be installed along with your package. Eg: 'caer'
+    keywords=["python", "model monitoring", "whitebox", "mlops"],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+    ],
+)