Merge pull request #1 from ML-KULeuven/setup-github

Setup GitHub

.github/workflows/python-package.yml

@@ -20,21 +20,31 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+
+    - name: Set up Java
+      uses: actions/setup-java@v3
+      with:
+        java-version: '21'
+        distribution: 'adopt'
+
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         python -m pip install flake8 pytest
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
     - name: Test with pytest
       run: |
         pytest

README.md

@@ -1,13 +1,15 @@
 # PaTSEmb
 
-[![pipeline status](https://gitlab.kuleuven.be/u0143709/patsemb/badges/main/pipeline.svg)](https://gitlab.kuleuven.be/u0143709/patsemb/-/commits/main)
-[![coverage report](https://gitlab.kuleuven.be/u0143709/patsemb/badges/main/coverage.svg)](https://gitlab.kuleuven.be/u0143709/patsemb/-/commits/main)
+[![PyPi Version](https://img.shields.io/pypi/v/patsemb.svg)](https://pypi.org/project/patsemb/)
+[![Downloads](https://static.pepy.tech/badge/patsemb)](https://pepy.tech/project/patsemb)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/patsemb)](https://pypi.python.org/pypi/patsemb/)
+[![PyPI license](https://img.shields.io/pypi/l/patsemb.svg)](https://pypi.python.org/pypi/patsemb/)
 
 Welcome to ``PaTSEmb``, a fast and extendable Python package for creating a pattern-based embedding
 of the time series. This is an embedding of the time series which contains information
 about the typical shapes are occurring at which locations in the time series. 
 Below, we give a small example of how to do this, but be sure to check out the 
-[documentation](https://patsemb-u0143709-3a07c9d27a51b62b1b2bad2f623ad154a9a19db833f1f7.pages.gitlab.kuleuven.be/index.html)!
+[documentation](https://PaTSEmb.readthedocs.io/)!
 
 ## Installation
 
@@ -17,12 +19,12 @@ pip install patsemb
 ```
 If you want to mine frequent, sequential patterns, Java 1.7 or higher should also be 
 available on your machine. More information about installing ``PaTSEmb`` can be found 
-in the [documentation](https://patsemb-u0143709-3a07c9d27a51b62b1b2bad2f623ad154a9a19db833f1f7.pages.gitlab.kuleuven.be/getting_started/installation.html).
+in the [documentation](https://PaTSEmb.readthedocs.io/en/stable/installation.html).
 
 ## Example 
 
 The code snippet below shows how to create the pattern-based embedding of a 
-time series. Be sure to check out the [example notebook](https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb/-/blob/main/notebooks/examples.ipynb?ref_type=heads) 
+time series. Be sure to check out the [example notebook](notebooks/examples) 
 for more examples!
 
 ```python

docs/getting_started/examples.rst

@@ -26,7 +26,7 @@ We will use this embedder throughout all examples.
     )
 ..
 
-The examples described below are also available in the `examples notebook <https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb/-/blob/main/notebooks/examples.ipynb>`_!
+The examples described below are also available in the `examples notebook <https://github.com/ML-KULeuven/PaTSEmb/blob/main/notebooks/examples.ipynb>`_!
 
 .. _example-univariate-time-series:
 

docs/getting_started/installation.rst

@@ -18,30 +18,30 @@ simply running the following command:
 
     pip install patsemb
 
-From GitLab
+From GitHub
 -----------
 
-You can also install ``PaTSEmb`` directly from `GitLab <https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb>`_.
+You can also install ``PaTSEmb`` directly from `GitHub <https://github.com/ML-KULeuven/PaTSEmb>`_.
 To install version ``X.Y.Z``, you can use the following command:
 
 .. code-block:: bash
 
-    pip install git+https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb.git@X.Y.Z
+    pip install git+https://github.com/ML-KULeuven/PaTSEmb.git@X.Y.Z
 
-The `release page <https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb/-/releases>`_ contains more
+The `release page <https://github.com/ML-KULeuven/PaTSEmb/releases>`_ contains more
 information regarding the different versions. It is also possible to install the
 latest, *unreleased* version using the following command:
 
 .. code-block:: bash
 
-    pip install git+https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb.git
+    pip install git+https://github.com/ML-KULeuven/PaTSEmb.git
 
 From source
 -----------
 
 It is also possible to install ``PaTSEmb`` directly from the source code. First, download
-the source from `GitLab <https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb>`_. It is also
-possible to download the source code for a specific release on `the release page <https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb/-/releases>`_.
+the source from `GitHub <https://github.com/ML-KULeuven/PaTSEmb.git>`_. It is also
+possible to download the source code for a specific release on `the release page <https://github.com/ML-KULeuven/PaTSEmb/releases>`_.
 Unzip the files, and navigate to the root directory of the repository in the terminal.
 Finally, ``PaTSEmb`` can be installed through the following command:
 

docs/index.rst

@@ -6,7 +6,7 @@ Welcome to ``PaTSEmb``, a fast and extendable Python package for creating a patt
 of the time series. This is an embedding of the time series which contains information
 about the typical shapes are occurring at which locations in the time series.
 
-The source is available on `GitLab <https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb>`_.
+The source is available on `GitHub <https://github.com/ML-KULeuven/PaTSEmb>`_.
 
 .. toctree::
    :maxdepth: 1

pyproject.toml

@@ -27,9 +27,9 @@ file = "LICENSE"
 
 [project.urls]
 homepage = "https://pypi.org/project/patsemb/"
-repository = "https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb"
-changelog = "https://gitlab.kuleuven.be/m-group-campus-brugge/dtai_public/patsemb/-/blob/main/CHANGELOG.md"
-documentation = "https://patsemb-u0143709-3a07c9d27a51b62b1b2bad2f623ad154a9a19db833f1f7.pages.gitlab.kuleuven.be/"
+repository = "https://github.com/ML-KULeuven/PaTSEmb"
+changelog = "https://github.com/ML-KULeuven/PaTSEmb/blob/main/CHANGELOG.md"
+documentation = "https://PaTSEmb.readthedocs.io/"
 
 [build-system]
 requires = ["setuptools", "wheel", "build"]