Metadata-Version: 2.4
Name: deciphon
Version: 1.0.7
Summary: Individually annotate long, error-prone nucleotide sequences into proteins
Author-email: Danilo Horta <horta@ebi.ac.uk>
License-Expression: MIT
License-File: LICENSE
Requires-Python: ~=3.11
Requires-Dist: cffi~=1.17
Requires-Dist: deciphon-core>=1.0.13
Requires-Dist: deciphon-poster>=0.2.4
Requires-Dist: deciphon-schema>=0.2.0
Requires-Dist: deciphon-snap<2,>=1.0.3
Requires-Dist: deciphon-worker>=0.5.2
Requires-Dist: fasta-reader<4,>=3.0.3
Requires-Dist: h3daemon>=2.0.2
Requires-Dist: h3result<2,>=1.0.3
Requires-Dist: hmmer~=3.4
Requires-Dist: ijson~=3.3
Requires-Dist: loguru<0.8,>=0.7.2
Requires-Dist: more-itertools~=10.5
Requires-Dist: paho-mqtt>=2.1.0
Requires-Dist: pip>=24.3.1
Requires-Dist: psutil<7,>=6.1.0
Requires-Dist: pydantic~=2.9
Requires-Dist: rich~=13.8
Requires-Dist: typer<0.16,>=0.15
Description-Content-Type: text/markdown

# Welcome to deciphon 👋

> Individually annotate long, error-prone nucleotide sequences into proteins

### 🏠 [Homepage](https://github.com/EBI-Metagenomics/deciphon-py)

## ⚡️ Requirements

- Python >= 3.9
- Pip
- [Podman](https://podman.io) >= 3.4
- [Homebrew](https://brew.sh) on MacOS (recommended)
- [Pipx](https://pypa.github.io/pipx/) for Python package management (recommended)

### MacOS

Install Python and Podman:

```sh
brew update && brew install python podman pipx
```

Ensure that your `PATH` environment variable is all set:

```sh
pipx ensurepath
```

💡 You might need to close your terminal and reopen it for the changes to take effect.

### Ubuntu (and Debian-based distros)

Install Python and Podman:

```sh
sudo apt update && \
    sudo apt install python3 python3-pip python3-venv podman --yes && \
    python3 -m pip install --user pipx
```

Ensure that your `PATH` environment variable is all set:

```sh
python3 -m pipx ensurepath
```

💡 You might need to close your terminal and reopen it for the changes to take effect.

## Install

```sh
pipx install deciphon
```

## Usage

```
 Usage: deci [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --version                                                                    │
│ --help             Show this message and exit.                               │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ press        Press HMM ASCII file into a Deciphon database one.              │
│ scan         Annotate nucleotide sequences into proteins a protein database. │
╰──────────────────────────────────────────────────────────────────────────────╯
```

## Example

Download the `minifam.hmm` protein database:

```sh
curl -O https://raw.githubusercontent.com/EBI-Metagenomics/deciphon/main/cli/tests/files/minifam.hmm
```

Download the `consensus.fna` file of sequences:

```sh
curl -O https://raw.githubusercontent.com/EBI-Metagenomics/deciphon/main/cli/tests/files/sequences.fna
```

Press it (using The Standard Code):

```sh
deci press minifam.hmm 1
```

Scan it:

```sh
deci scan minifam.hmm sequences.fna
```

Show it:

```sh
deci see sequences.dcs
```

## 👤 Author

- [Danilo Horta](https://github.com/horta)

## Show your support

Give a ⭐️ if this project helped you!
