User Guide#

Welcome to skbase’s user guide!

The purpose of the user guide is to provide further explanations and context to developers who want to use skbase to help create their own packages.

If your just looking for a technical specification of the functionality that skbase provides, see the API Reference.

Note

The user guide is under development. We have created a basic structure and are looking for contributions to develop the user guide further.

Overview

Get an overview of baseobject’s interfaces and design patterns.

Base Classes

The skbase class interface.

Retrieval

Tools for collecting BaseObject-s, and metadata on your project.

Testing

Tools for testing BaseObject-s.