Gen3 SDK for Python (w/ CLI)

The Gen3 Software Development Kit (SDK) for Python provides classes and functions for handling common tasks when interacting with a Gen3 commons. It also exposes a Command Line Interface (CLI).

The API for a commons can be overwhelming, so this SDK/CLI aims to simplify communication with various microservices.

The docs here contain general descriptions of the different pieces of the SDK and example scripts. For detailed API documentation, see the link below:

• Detailed API Documentation

Prerequisites

This project is built with Python. Ensure you have Python 3.6 or later installed.

Other prerequisites include:

• pip
• Access to a Gen3 commons.

Installation Steps:

Using pip

To install the latest released version of the SDK, run:

pip install gen3

This SDK exposes a Command Line Interface (CLI). You can import functions from gen3 into your own Python scripts or use the CLI:

gen3 --help

External Documents

Additional documentation for different components is available:

• Scripting Quickstart
• Available Classes
• Indexing Tools
• Metadata Tools
  • Gen3 Discovery Page Metadata Tools
  • Gen3 Subject-level Crosswalk Metadata Tools
• Bundle Tools
• Development
• CLI

Help and Support

For FAQs and commonly encountered errors, consult the documentation or use the CLI --help option:

gen3 --help

If you encounter issues, raise them on the Gen3 SDK GitHub Issues page.