rename to skbase

renames package and project to skbase.
Rename to baseobject is easy, simply revert this.

.all-contributorsrc

@@ -61,7 +61,7 @@
         ]
       }
   ],
-  "projectName": "BaseObject",
+  "projectName": "skbase",
   "projectOwner": "sktime",
   "repoType": "github",
   "repoHost": "https://github.com",

.github/workflows/wheels.yml

@@ -48,7 +48,7 @@ jobs:
           path: wheelhouse
 
       - name: Get wheel filename
-        run: echo "WHEELNAME=$(ls ./wheelhouse/baseobject-*none-any.whl)" >> $GITHUB_ENV
+        run: echo "WHEELNAME=$(ls ./wheelhouse/skbase-*none-any.whl)" >> $GITHUB_ENV
 
       - name: Install wheel and extras
         run: python -m pip install "${{ env.WHEELNAME }}[all_extras,dev]"
@@ -115,7 +115,7 @@ jobs:
         run: ls -l wheelhouse
 
       - name: Get wheel filename
-        run: echo "WHEELNAME=$(ls ./wheelhouse/baseobject-*none-any.whl)" >> $env:GITHUB_ENV
+        run: echo "WHEELNAME=$(ls ./wheelhouse/skbase-*none-any.whl)" >> $env:GITHUB_ENV
 
       - name: Activate conda env
         run: conda activate test

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2022, BaseObject Developers
+Copyright (c) 2022, skbase Developers
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,17 +1,17 @@
 
-# Welcome to BaseObject
+# Welcome to skbase
 
 > A base class for scikit-learn-like and sktime-like parametric objects
 
-baseobject provides base classes for creating scikit-learn-like parametric objects,
+`skbase` provides base classes for creating scikit-learn-like parametric objects,
 along with tools to make it easier to build your own packages that follow these
 design patterns.
 
 | Overview | |
 |---|---|
 | **CI/CD** | [![Tests](https://github.com/sktime/baseobject/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/sktime/baseobject/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/sktime/baseobject/branch/main/graph/badge.svg?token=2J424NLO82)](https://codecov.io/gh/sktime/baseobject) [![Documentation Status](https://readthedocs.org/projects/baseobject/badge/?version=latest)](https://baseobject.readthedocs.io/en/latest/?badge=latest) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sktime/BaseObject/main.svg)](https://results.pre-commit.ci/latest/github/sktime/BaseObject/main) |
-| **Code** |  [![!pypi](https://img.shields.io/pypi/v/baseobject?color=orange)](https://pypi.org/project/baseobject/)  [![!python-versions](https://img.shields.io/pypi/pyversions/baseobject)](https://www.python.org/) [![!black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit) |
-| **Downloads**| [![Downloads](https://static.pepy.tech/personalized-badge/baseobject?period=week&units=international_system&left_color=grey&right_color=blue&left_text=weekly%20(pypi))](https://pepy.tech/project/baseobject) [![Downloads](https://static.pepy.tech/personalized-badge/baseobject?period=month&units=international_system&left_color=grey&right_color=blue&left_text=monthly%20(pypi))](https://pepy.tech/project/baseobject) [![Downloads](https://static.pepy.tech/personalized-badge/baseobject?period=total&units=international_system&left_color=grey&right_color=blue&left_text=cumulative%20(pypi))](https://pepy.tech/project/baseobject) |
+| **Code** |  [![!pypi](https://img.shields.io/pypi/v/skbase?color=orange)](https://pypi.org/project/skbase/)  [![!python-versions](https://img.shields.io/pypi/pyversions/skbase)](https://www.python.org/) [![!black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit) |
+| **Downloads**| [![Downloads](https://static.pepy.tech/personalized-badge/skbase?period=week&units=international_system&left_color=grey&right_color=blue&left_text=weekly%20(pypi))](https://pepy.tech/project/skbase) [![Downloads](https://static.pepy.tech/personalized-badge/skbase?period=month&units=international_system&left_color=grey&right_color=blue&left_text=monthly%20(pypi))](https://pepy.tech/project/skbase) [![Downloads](https://static.pepy.tech/personalized-badge/skbase?period=total&units=international_system&left_color=grey&right_color=blue&left_text=cumulative%20(pypi))](https://pepy.tech/project/skbase) |
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
@@ -21,7 +21,7 @@ design patterns.
 
 To learn more about the package checkout our [documentation](https://baseobject.readthedocs.io/en/latest/).
 
-## :hourglass_flowing_sand: Install baseobject
+## :hourglass_flowing_sand: Install skbase
 For trouble shooting or more information, see our
 [detailed installation instructions](https://baseobject.readthedocs.io/en/latest/user_documentation/installation.html).
 
@@ -32,17 +32,17 @@ For trouble shooting or more information, see our
 [pip]: https://pip.pypa.io/en/stable/
 
 ### pip
-baseobject releases are available as source packages and binary wheels via PyPI
-and can be installed using pip. Checkout the full list of pre-compiled [wheels on PyPi](https://pypi.org/simple/baseobject/).
+skbase releases are available as source packages and binary wheels via PyPI
+and can be installed using pip. Checkout the full list of pre-compiled [wheels on PyPi](https://pypi.org/simple/skbase/).
 
 To install the core package use:
 
 ```bash
-pip install baseobject
+pip install skbase
 ```
 
 or, if you want to install with the maximum set of dependencies, use:
 
 ```bash
-pip install baseobject[all_extras]
+pip install skbase[all_extras]
 ```

SECURITY.md

@@ -8,7 +8,7 @@
 
 ## Reporting a Vulnerability
 
-Please report security vulnerabilities by email to `rk.baseobject@gmail.com`.
-This email will be forward to the relevent members of the `BaseObject` development team.
+Please report security vulnerabilities by email to `rk.skbase@gmail.com`.
+This email will be forward to the relevent members of the `skbase` development team.
 
 If the security vulnerability is accepted, a patch will be developed privately to provide a bugfix release as soon as possible.

baseobject/__init__.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3 -u
 # -*- coding: utf-8 -*-
-# copyright: BaseObject developers, BSD-3-Clause License (see LICENSE file)
-""":mod:`baseobject` contains tools for creating and working with parametric objects.
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
+""":mod:`skbase` contains tools for creating and working with parametric objects.
 
 The included functionality makes it easy to re-use scikit-learn and
 sktime design principles in your project.

baseobject/_base.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# copyright: BaseObject developers, BSD-3-Clause License (see LICENSE file)
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
 # Elements of BaseObject re-use code developed in scikit-learn. These elements
 # are copyrighted by the scikit-learn developers, BSD-3-Clause License. For
 # conditions see https://github.com/scikit-learn/scikit-learn/blob/main/COPYING

baseobject/_exceptions.py

@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
-# copyright: BaseObject developers, BSD-3-Clause License (see LICENSE file)
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
 # NotFittedError re-use code developed in scikit-learn. These elements
 # are copyrighted by the scikit-learn developers, BSD-3-Clause License. For
 # conditions see https://github.com/scikit-learn/scikit-learn/blob/main/COPYING
-"""Custom exceptions used in ``baseobject``."""
+"""Custom exceptions used in ``skbase``."""
 from typing import List
 
 __author__: List[str] = ["mloning", "rnkuhns"]

baseobject/_lookup.py

@@ -1,13 +1,13 @@
 # -*- coding: utf-8 -*-
-# copyright: BaseObject developers, BSD-3-Clause License (see LICENSE file)
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
 """Tools to lookup information on code artifacts in a Python package or module.
 
 This module exports the following methods for registry lookup:
 
 package_metadata()
     Walk package and return metadata on included classes and functions by module.
 all_objects(object_types, filter_tags)
-    Look (and optionally filter) BaseObject descendents in a package or module.
+    Look (and optionally filter) BaseObject descendants in a package or module.
 
 """
 # all_objects is based on the sktime all_estimator retrieval utility, which

baseobject/_meta.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3 -u
 # -*- coding: utf-8 -*-
-# copyright: BaseObject developers, BSD-3-Clause License (see LICENSE file)
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
 # _HeterogenousMetaEstimator re-use code developed in scikit-learn. These elements
 # are copyrighted by the scikit-learn developers, BSD-3-Clause License. For
 # conditions see https://github.com/scikit-learn/scikit-learn/blob/main/COPYING

baseobject/testing/test_all_objects.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# copyright: baseobject developers, BSD-3-Clause License (see LICENSE file)
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
 """Suite of tests for all objects.
 
 adapted from scikit-learn's and sktime's estimator_checks

baseobject/tests/test_base.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# copyright: BaseObject developers, BSD-3-Clause License (see LICENSE file)
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
 """Tests for BaseObject universal base class.
 
 tests in this module:

docs/source/about.rst

@@ -4,7 +4,7 @@
 About
 =====
 
-Learn more about the ``baseobject`` project and its community.
+Learn more about the ``skbase`` project and its community.
 
 .. toctree::
    :maxdepth: 1
@@ -25,7 +25,7 @@ Learn more about the ``baseobject`` project and its community.
     Mission
     ^^^^^^^
 
-    ``baseobject's`` mission.
+    ``skbase's`` mission.
 
     +++
 
@@ -39,7 +39,7 @@ Learn more about the ``baseobject`` project and its community.
     History
     ^^^^^^^
 
-    Learn about ``baseobject's`` history.
+    Learn about ``skbase's`` history.
 
     +++
 
@@ -53,7 +53,7 @@ Learn more about the ``baseobject`` project and its community.
     Development Team
     ^^^^^^^^^^^^^^^^
 
-    ``baseobject's`` core development team.
+    ``skbase's`` core development team.
 
     +++
 
@@ -67,7 +67,7 @@ Learn more about the ``baseobject`` project and its community.
     Contributors
     ^^^^^^^^^^^^
 
-    All of ``baseobject's`` contributors.
+    All of ``skbase's`` contributors.
 
     +++
 

docs/source/about/governance.rst

@@ -7,15 +7,15 @@ Governance
 Overview
 ========
 
-``baseobject`` is a consensus-based project that is part of the ``sktime`` community.
+``skbase`` is a consensus-based project that is part of the ``sktime`` community.
 Anyone with an interest in the project can join the community, contribute to
 the project, and participate in the governance process. The rest of this document
 describes how that participation takes place, which roles we have in our community,
 how we make decisions, and how we acknowledge contributions.
 
 .. note::
 
-    As a new project, ``baseobject`` has adopted a governance structure similar
+    As a new project, ``skbase`` has adopted a governance structure similar
     to ``sktime``. In the future this could change as the project grows. But for
     the time being, any governance process not covered by this document, defaults
     to ``sktime's`` process.
@@ -25,14 +25,14 @@ how we make decisions, and how we acknowledge contributions.
 Code of Conduct
 ===============
 
-The ``baseobject`` project believes that everyone should be able to participate
+The ``skbase`` project believes that everyone should be able to participate
 in our community without fear of harrassment or discrimination (see our
 :ref:`Code of Conduct guide <coc>`).
 
 Roles
 =====
 
-``baseobject`` distinguishes between the following key community roles:
+``skbase`` distinguishes between the following key community roles:
 
 - :ref:`Contributors`
 - :ref:`Core developers <core-devs>`
@@ -111,7 +111,7 @@ can vote to remove them (same voting rules as appointment).
 Decision making
 ===============
 
-``baseobject's`` tries to take feedback from all community members into account
+The ``skbase`` community tries to take feedback from all community members into account
 when making decisions and strives to find consensus and avoid deadlocks.
 
 To accomplish this, this section outlines the decision-making process used
@@ -167,13 +167,13 @@ and no rejections (excercise of core developer veto right).
 
 .. _gov_bep:
 
-``baseobject`` enhancement proposals
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+``skbase`` enhancement proposals
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Project design decisions have a more detailed approval process,
 commensurate with their broader impact on the project. Any changes
 to the project's core API design, hard dependencies or supported versions
-should first be presented in a ``baseobject`` enhancement proposal (BEP).
+should first be presented in a ``skbase`` enhancement proposal (BEP).
 
 See the developer guide for more information on creating a :ref:`BEP <bep>`.
 
@@ -211,7 +211,7 @@ if we have missed anything.
 
 .. note::
 
-  ``baseobject`` is an open-source project. All code is contributed
+  ``skbase`` is an open-source project. All code is contributed
   under `our open-source
   license <https://github.com/sktime/baseobject/blob/main/LICENSE>`_.
   Contributors acknowledge that they have rights to make their contribution

docs/source/about/history.rst

@@ -4,15 +4,15 @@
 History
 =======
 
-``baseobject`` was started in May 2022 by Franz Király and Ryan Kuhns
+``skbase`` was started in May 2022 by Franz Király and Ryan Kuhns
 in order to make it easier for others to use `scikit-learn`_ and `sktime`_
 design principles in a range of projects.
 
 The project builds on and was heavily inspired by
 `scikti-learn's <scikit-learn-about>`_ `BaseEstimator API <scikit-learn-est>`_.
 `sktime`_ built on this by developing a ``BaseObject`` that built on these
 design principles and added an `sktime`_ interface for
-general parametric objects. The ``baseobject`` project is focused on continuing
+general parametric objects. The ``skbase`` project is focused on continuing
 to build on these efforts, while further genericizing the design concept to
 a variety of use-cases.
 

docs/source/about/mission.rst

@@ -4,7 +4,7 @@
 Mission
 =======
 
-baseobject's goal is to make it easy to develop your own packages that
+The goal of the ``skbase`` project is to make it easy to develop your own packages that
 follow `scikit-learn`_ and `sktime`_ design principles.
 
 Our :ref:`roadmap` gives more details on how we try to achieve our mission.

docs/source/about/roadmap.rst

@@ -4,7 +4,7 @@
 Roadmap
 =======
 
-Welcome to `baseobjects`'s roadmap.
+Welcome to ``skbase``'s roadmap.
 
 .. note::
 
@@ -14,22 +14,22 @@ Welcome to `baseobjects`'s roadmap.
 Project Goals
 =============
 
-``baseobject`` aims to provide easy-to-use tools for working with and
+``skbase`` aims to provide easy-to-use tools for working with and
 developing new packages that use `scikit-learn`_ and `sktime`_ style
 parametric objects.
 
 To accomplish this we plan to:
 
 - Add additional unit tests
 - Refactor existing package functionality to minimize dependencies
-- Finalizing and implementing an API for ``BaseObjects``
-- Expanding the user guide documentation that explains ``baseobject's`` core concepts
-- Provide tutorials on using ``baseobject`` in your own projects
+- Finalizing and implementing an API for ``BaseObject``-s
+- Expanding the user guide documentation that explains ``skbase``'s core concepts
+- Provide tutorials on using ``skbase`` in your own projects
 
 We are also considering creating:
 
 - A template repository that developers can use to easily create their own
-  package based on ``baseobject's`` design and also test the ``baseobject``
+  package based on ``skbase``'s design and also test the ``skbase``
   package's testing interface.
 
 .. _scikit-learn: https://scikit-learn.org/stable/index.html

docs/source/about/team.rst

@@ -5,7 +5,7 @@ Development Team
 ================
 
 Information about the rights and responsibilities associated with each role
-are described in baseobject's :ref:`governance` document. A list of
+are described in ``skbase``'s :ref:`governance` document. A list of
 all contributors can be found under the `contributors <contributors.md>`_
 section.
 

docs/source/api_reference.rst

@@ -4,7 +4,7 @@
 API Reference
 =============
 
-Welcome to the API reference for ``baseobject``.
+Welcome to the API reference for ``skbase``.
 
 The API reference provides a technical manual, describing the class and
 function interface provided by the package. See the :ref:`user_guide` for

docs/source/conf.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-# copyright: BaseObject developers, BSD-3-Clause License (see LICENSE file)
-"""Configure BaseObject's Sphinx documentation."""
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
+"""Configure skbase Sphinx documentation."""
 
 # -- Path setup --------------------------------------------------------------