geneweaver-client

Geneweaver Client

This is a client for the Geneweaver API. It is written in Python 3.9 and is intended to be used as a library for other applications. It can also be used as a command line tool.

Installation

This library is tested on python version 3.9, 3.10, and 3.11, on MacOS and on Ubuntu Linux. The library should work on any version of python 3.9 or higher.

From PyPI

pip install geneweaver-client

From Source

Installing from source requires python 3.9 and poetry.

git clone $GIT_URL
cd geneweaver-client
poetry install

Usage

As a library

Using Authentication Tools

from geneweaver.client import auth
auth.login()
auth.get_access_token()

Complete Example

See the Geneweaver Docs

As a command line tool

gweave --help

GeneWeaver CLI client.

Usage:

$ gweave [OPTIONS] COMMAND [ARGS]...

Options:

• --version
• --install-completion: Install completion for the current shell.
• --show-completion: Show completion for the current shell, to copy it or customize the installation.
• --help: Show this message and exit.

Commands:

• alpha: These commands are in alpha testing.
• beta: These commands are in beta testing.

gweave beta

These commands are in beta testing.

They are subject to future change and/or removal. Beta commands are intended to be released beyond beta testing, but may have bugs or other issues. There is also no guarantee that beta commands will be released beyond beta testing.

Use at your own risk.

Usage:

$ gweave beta [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• auth

gweave beta auth

Usage:

$ gweave beta auth [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• login: Run the device authorization flow.

gweave beta auth login

Run the device authorization flow.

:param reauth: Force a re-authentication

Usage:

$ gweave beta auth login [OPTIONS]

Options:

• --reauth
• --help: Show this message and exit.