Skip to main content

An unofficial client for uniprot.

Project description

uniprot-cli - An Unofficial client for Uniprot

uniprot-cli is an Unofficial client for the Uniprot protein database written in python.

This project is still in its early stages under heavy development. Do not expect this to work properly until v1.0.0.

Installation

Installation is done with pip:

pip install uniprot-cli

Usage

uniprot-cli has two modes of usage, an interactive-mode and a cli-mode. The interactive-mode can be invoked by simply running:

uniprot-cli

And the user will be prompted for relevant input, step by step.

The cli-mode is used by passing arguments to uniprot-cli in the terminal:

Example:

uniprot-cli -q B5ZC00

This will cause uniprot-cli to skip interactive prompts and query Uniprot directly.

Arguments

The following arguments can be passed to uniprot-cli in cli-mode:

Argument Type Default Explaination
-q, --query str None Query string.
-m, --multiple bool False Query multiple results.
-f, --format str 'fasta' Data format for query result.
-d, --dataset str 'uniprotkb' Data set on Uniprot.
-n, --nosave bool False Don't save the result.
-v, --version N/A N/A Print version.
-h, --help N/A N/A Print help and usage information.

Project details


Download files

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

Source Distribution

uniprot_cli-0.3.4.tar.gz (5.9 kB view hashes)

Uploaded source

Built Distribution

uniprot_cli-0.3.4-py3-none-any.whl (6.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page