Merge pull request #40 from juaduan/dev

Update build pipeline, edit readme

.github/workflows/cd.yml

@@ -0,0 +1,68 @@
+name: Build and Release
+on:
+  push:
+    tags:
+      - 'v*'
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: 'Name of the branch to build and release'
+        required: true
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest]
+        python-version: ['3.9', '3.10.8', '3.11']
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine cython numpy
+
+    - name: Build a binary wheel and a source tarball
+      run: |
+        python setup.py bdist_wheel sdist
+
+    - name: Rename wheel for manylinux compatibility (Ubuntu only)
+      if: runner.os == 'Linux'
+      run: |
+        for file in *.whl; do
+          if [[ $file == *linux* ]]; then
+              mv "$file" "${file/-linux/-manylinux1}"
+          fi
+        done
+
+    - name: Publish artifacts
+      uses: actions/upload-artifact@v2
+      with:
+        name: dist
+        path: dist/
+
+  release:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Download artifacts
+      uses: actions/download-artifact@v2
+      with:
+        name: dist
+        path: dist/
+
+    - name: Publish to GitHub Releases
+      uses: softprops/action-gh-release@v1
+      with:
+        files: dist/*
+        tag_name: v${{ github.ref }}
+        title: Release ${{ github.ref }}
+        body: ${{ github.event.pull_request.body }}

.gitignore

@@ -404,10 +404,9 @@ venv/
 dist/
 temp/
 build/
-anomaly_detector.egg-info/
+time_series_anomaly_detector.egg-info/
 anomaly-detector/anomaly_detector/univariate/_anomaly_kernel_cython.c
-
 .idea/
 *.so
-
+*.pyd
 .script\Dockerfile

README.md

@@ -11,6 +11,10 @@ Tested on
 ## Installing from pip
 
 ```bash
+# install dependencies
+pip install numpy>=1.23.5 Cython
+
+# then install time-series-anomaly-detector
 pip install time-series-anomaly-detector
 ```