---

Overview

smaht-submitr: A metadata and file submission tool for SMaHT Portal.

Note

You need a SMaHT account to use this software. For information on obtaining an account please see the SMaHT Portal Account Creation page. See the About page for more general information about this tool and the SMaHT project.

Description

The smaht-submitr software is a command-line tool for importing and uploading metadata and files into the SMaHT Portal. It is implemented as Python package and distributed on PyPi here: smaht-submitr. This document explains how to get up and running with the use of this tool.

For more information about this software and the SMaHT project see: About

Tip

This documentation covers the mechanics of using smaht-submitr. It does not at this time cover the semantics of the metadata; though there is an Object Model reference. For more information on this aspect of submission please see: TBD

System Requirements

• python 3.9, 3.10, or 3.11

Note

These instructions are targeted specifically for Mac OS X users. For Linux users, these should be generally applicable (with slight modifications); presumed to be a bit more advanced, such users should have little difficulty. For Windows users, very little testing has been done; not recommended; but more experienced users should be able to work through it.

What To Do Next

More experienced users who already have Python installed to their satisfaction can proceed to instructions for Installation.

Less experienced users should start with instructions for Installation Prerequisites, which will introduce some basics for working with the terminal and installing the dependencies for this tool:

• Installation Prerequisites

Below (and to the left) is the general table of contents for this documentation.

General ℹ️

• Overview
• About

Setup ⚙️

• Installation
• Account Creation
• Credentials

Documentation 📄

• Submitting Metadata
• Uploading Files
• Advanced Usage

Reference 🔍

• Object Model
• Glossary