rename

Author: MatthewMiddlehurst

.coveragerc

@@ -1,4 +1,4 @@
 [run]
 branch = True
-source = tsml_subpackage_template
+source = tsml
 parallel = True

.github/workflows/release.yml

@@ -82,10 +82,10 @@ jobs:
 
       - if: matrix.os == 'windows-latest'
         name: Windows wheel filename
-        run: echo "WHEELNAME=$(ls ./dist/tsml_subpackage_template-*-none-any.whl)" >> $env:GITHUB_ENV
+        run: echo "WHEELNAME=$(ls ./dist/tsml-*-none-any.whl)" >> $env:GITHUB_ENV
       - if: matrix.os != 'windows-latest'
         name: Unix wheel filename
-        run: echo "WHEELNAME=$(ls ./dist/tsml_subpackage_template-*-none-any.whl)" >> $GITHUB_ENV
+        run: echo "WHEELNAME=$(ls ./dist/tsml-*-none-any.whl)" >> $GITHUB_ENV
 
       - if: matrix.os == 'windows-latest'
         name: Windows install

MANIFEST.in

@@ -1,2 +1,2 @@
-recursive-include tsml_subpackage_template *.py
+recursive-include tsml *.py
 include LICENSE

README.md

@@ -1,5 +1,5 @@
-# tsmlPy-subpackage-template
+# tsml
 
-A template package for other tsmlPy subpackages using the sktime toolkit.
+A toolkit for time series machine learning algorithms
 
 This work is supported by the UK Engineering and Physical Sciences Research Council (EPSRC) EP/W030756/1

docs/api.rst

@@ -5,12 +5,12 @@ API
 
 Auto-generated API documentation.
 
-Package: tsml_subpackage_template.package
+Package: tsml.package
 -----------------------------------------
 
 Example package function.
 
-.. currentmodule:: tsml_subpackage_template.package
+.. currentmodule:: tsml.package
 
 .. autosummary::
     :toctree: auto_generated/

docs/conf.py

@@ -1,21 +1,21 @@
 # -*- coding: utf-8 -*-
 """Configuration file for the Sphinx documentation builder."""
 
-# tsml-subpackage-template documentation master file, created by
+# tsml documentation master file, created by
 # sphinx-quickstart on Wed Dec 14 00:20:27 2022.
 
 import inspect
 import os
 import sys
 
-import tsml_subpackage_template
+import tsml
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 
-version = tsml_subpackage_template.__version__
-release = tsml_subpackage_template.__version__
+version = tsml.__version__
+release = tsml.__version__
 
 github_tag = f"v{version}"
 
@@ -37,7 +37,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "tsml-subpackage-template"
+project = "tsml"
 copyright = "2022 - 2023, The tsml developers (BSD-3 License)"
 author = "Matthew Middlehurst"
 
@@ -87,8 +87,8 @@
 
 # add link to original notebook at the bottom and add Binder launch button
 # points to latest stable release, not main
-notebook_url = f"https://github.com/time-series-machine-learning/tsml-subpackage-template/tree/{github_tag}/{current_file}"  # noqa
-binder_url = f"https://mybinder.org/v2/gh/time-series-machine-learning/tsml-subpackage-template/{github_tag}?filepath={current_file}"  # noqa
+notebook_url = f"https://github.com/time-series-machine-learning/tsml-py/tree/{github_tag}/{current_file}"  # noqa
+binder_url = f"https://mybinder.org/v2/gh/time-series-machine-learning/tsml-py/{github_tag}?filepath={current_file}"  # noqa
 nbsphinx_epilog = f"""
 ----
 
@@ -120,24 +120,18 @@ def find_source():
             obj = getattr(obj, part)
 
         fn = inspect.getsourcefile(obj)
-        fn = os.path.relpath(
-            fn, start=os.path.dirname(tsml_subpackage_template.__file__)
-        )
+        fn = os.path.relpath(fn, start=os.path.dirname(tsml.__file__))
         source, lineno = inspect.getsourcelines(obj)
         return fn, lineno, lineno + len(source) - 1
 
     if domain != "py" or not info["module"]:
         return None
     try:
-        filename = "tsml_subpackage_template/%s#L%d-L%d" % find_source()
+        filename = "tsml/%s#L%d-L%d" % find_source()
     except Exception:
         filename = info["module"].replace(".", "/") + ".py"
 
-    return (
-        "https://github.com/time-series-machine-learning/"
-        + "tsml-subpackage-template/blob/%s/%s"
-        % (
-            version,
-            filename,
-        )
+    return "https://github.com/time-series-machine-learning/tsml-py/blob/%s/%s" % (
+        version,
+        filename,
     )

docs/index.rst

@@ -1,9 +1,9 @@
 .. _index:
 
-tsml-subpackage-template's documentation
+tsml's documentation
 ========================================
 
-Example documentation for a tsml subpackage.
+Example documentation for tsml.
 
 .. grid:: 1 2 2 2
     :gutter: 3

pyproject.toml

@@ -3,9 +3,9 @@ requires = ["setuptools>=61", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "tsml-subpackage-template"
-version = "0.0.0"
-description = "A template for tsml subpackages."
+name = "tsml"
+version = "0.0.1"
+description = "A toolkit for time series machine learning algorithms."
 authors = [
     {name = "Matthew Middlehurst", email = "m.middlehurst@uea.ac.uk"},
     {name = "Tony Bagnall", email = "ajb@uea.ac.uk"},
@@ -15,7 +15,11 @@ requires-python = ">=3.8,<3.11"
 keywords = [
     "data-science",
     "machine-learning",
+    "scikit-learn",
     "time-series",
+    "time-series-classification",
+    "time-series-regression",
+    "time-series-clustering",
 ]
 classifiers = [
     "Intended Audience :: Science/Research",
@@ -31,7 +35,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
 ]
 dependencies = [
-    "tsml",
+    "scikit-learn",
 ]
 
 [project.optional-dependencies]
@@ -55,13 +59,13 @@ docs = [
 
 [project.urls]
 homepage = "https://www.timeseriesclassification.com/"
-repository = "https://github.com/time-series-machine-learning/tsml-subpackage-template/"
+repository = "https://github.com/time-series-machine-learning/tsml-py/"
 
 [project.license]
 file = "LICENSE"
 
 [tool.setuptools.packages.find]
-include = ["tsml_subpackage_template"]
+include = ["tsml"]
 
 [tool.check-manifest]
 ignore = [
@@ -84,6 +88,6 @@ addopts = '''
     --showlocals
     --doctest-modules
     --numprocesses auto
-    --cov tsml_subpackage_template
+    --cov tsml
     --cov-report xml
 '''

requirements.txt

@@ -1 +1 @@
-tsml
+scikit-learn

tsml/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+"""tsml."""
+
+__version__ = "0.0.1"