Skip to main content

A Python Client for the Geneweaver API

Project description

Geneweaver Client

GitHub Actions Workflow Status Style Coverage

PyPI - License PyPI - Python Version PyPI - Version PyPI - Downloads

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

geneweaver_client-0.10.0.tar.gz (35.4 kB view details)

Uploaded Source

Built Distribution

geneweaver_client-0.10.0-py3-none-any.whl (53.2 kB view details)

Uploaded Python 3

File details

Details for the file geneweaver_client-0.10.0.tar.gz.

File metadata

  • Download URL: geneweaver_client-0.10.0.tar.gz
  • Upload date:
  • Size: 35.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1025-azure

File hashes

Hashes for geneweaver_client-0.10.0.tar.gz
Algorithm Hash digest
SHA256 e059d9a3fbf3cd90fec31f9d8417fbdf7e21867d45be30d67755d124692e8696
MD5 e5331724327467f9a6fee069a4ea5068
BLAKE2b-256 fcdc2c55a95ce4ebbb33e7b0b2bf7e2d8548ba712cbbe807bf3d7a2dca14553b

See more details on using hashes here.

File details

Details for the file geneweaver_client-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: geneweaver_client-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 53.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1025-azure

File hashes

Hashes for geneweaver_client-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a84f213644f85a381e67fe71028db62c892b22da7a5290dcc59da55eb244974d
MD5 ac7c459e38e7a97deab79dab2736fb32
BLAKE2b-256 b8d73a81b818b95ac12bb80547be92563b0ec2f183c1396bc989a60a9cdbf2d0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page