Documentation/Analysis/Developer Resources

Developer Resources

Comprehensive resources for developing plugins, extending functionality, and contributing to the Bioshift ecosystem.

Development Resources

Everything you need to develop, build, and contribute to Bioshift.

Plugin Development

Create custom nodes and extend Bioshift functionality

  • Plugin architecture overview
  • Creating custom node types
  • Plugin registration system
  • Example plugin templates
  • Plugin packaging and distribution

API Reference

Complete API documentation for Bioshift components

  • Core node base classes
  • Workflow manager API
  • Canvas interaction methods
  • Resource access utilities
  • Plugin system interfaces

Build System

Tools and processes for building and deploying Bioshift

  • Development environment setup
  • Building from source
  • Packaging for distribution
  • Nuitka compilation process
  • Cross-platform build configurations

Contributing

Guidelines for contributing to Bioshift development

  • Development workflow
  • Code style guidelines
  • Testing requirements
  • Documentation standards
  • Pull request process

Plugin Development Guide

Step-by-step guide to creating custom plugins and extending Bioshift functionality.

1

Step 1: Setup Development Environment

Prepare your development environment for plugin creation

What you'll learn:

  • Install Bioshift executable on your system
  • Download plugin template from documentation
  • Extract template and customize for your needs
  • Create plugin project structure
2

Step 2: Create Plugin Structure

Build the basic plugin architecture

What you'll learn:

  • Create plugin manifest file
  • Implement plugin main class
  • Define node types and classes
  • Set up plugin configuration
3

Step 3: Implement Custom Nodes

Develop your custom node functionality

What you'll learn:

  • Inherit from BaseNode class
  • Implement execute() method
  • Define input/output ports
  • Add node properties and UI
4

Step 4: Test and Deploy

Test your plugin and prepare for deployment

What you'll learn:

  • Test plugin functionality
  • Create plugin documentation
  • Package plugin for distribution
  • Submit to plugin registry

Example Plugins

Learn from these example plugins that demonstrate best practices and common patterns.

Hello Biosift Plugin

Simple example plugin demonstrating basic concepts

Features:
  • Basic node creation
  • Input/output handling
  • Property configuration
  • Plugin registration
Download

Custom Analysis Plugin

Advanced plugin with custom analysis algorithms

Features:
  • Custom analysis nodes
  • Integration with external tools
  • Advanced data processing
  • Custom visualization output
Download

Database Integration Plugin

Plugin for integrating external databases

Features:
  • Database connection management
  • Query execution nodes
  • Data import/export functionality
  • Authentication handling
Download