Welcome to spinneret

Release v0.6.0. (Installation)

For integrating EDI into the Semantic Web

---

Brief introduction

The User Guide

This part of the documentation begins with some background information about spinneret, then focuses on step-by-step instructions for getting the most out of it.

• Quickstart
  • Installation
  • Adding QUDT Annotations to an EML File
• Support and Assistance

The API Documentation / Guide

If you are looking for information on a specific function, class, or method, this part of the documentation is for you.

• Developer Interface
  • Annotator Module
  • Benchmark Module
  • Datasets Module
  • EML Module
  • Graph Module
  • Main Module
  • Plot Module
  • Shadow Module
  • SSSOM Module
  • Utilities Module
  • Workbook Module

The Contributor Guide

If you want to contribute to the project, this part of the documentation is for you.

• Contributor’s Guide
  • Be Courteous
  • Contribution Suitability
  • Code Contributions
    • Steps for Submitting Code
    • Code Review
    • Code Format and Analysis
  • Documentation Contributions
  • Bug Reports
  • Feature Requests
  • Commit Messages

The Maintainer Guide

If you are a project maintainer, this part of the documentation is for you.

• Maintainers Guide
  • Be Courteous
  • Pull Request Review
  • Git and GitHub
    • Commit Message Style
    • Branch Management
    • Branch Protection Rules
    • Secrets
    • Workflows
  • Developing Features as a Maintainer
  • Dependency and Environment Management

Project Design

The project design documentation provides an overview of the project’s architecture and design decisions.

• Project Design
  • Introduction
  • Architecture
  • Testing
  • Alternative Implementations Considered