Metadata-Version: 2.1
Name: uniprot_cli
Version: 0.3.0
Summary: An unofficial client for uniprot.
Author-email: HackTheOxidation <tomas.hagenau@protonmail.ch>
License: Copyright (c) 2022 HackTheOxidation
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Homepage, https://codeberg.org/HackTheOxidation/uniprot_cli
Project-URL: Bug Tracker, https://codeberg.org/HackTheOxidation/uniprot_cli/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# `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`:

```{sh}
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:
```{sh}
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:
```{sh}
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`  | ID to query                      |
| `-m`, `--multiple` | `bool` | `False` | Query multiple results           |
| `-h`, `--help`     |  N/A   |  N/A    | Print help and usage information |
