| Name | deciphon JSON |
| Version |
1.0.3
JSON |
| download |
| home_page | None |
| Summary | Individually annotate long, error-prone nucleotide sequences into proteins |
| upload_time | 2024-12-02 10:51:09 |
| maintainer | None |
| docs_url | None |
| author | Danilo Horta |
| requires_python | <4.0,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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!
Raw data
{
"_id": null,
"home_page": null,
"name": "deciphon",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Danilo Horta",
"author_email": "horta@ebi.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/83/a0/6f6ef2a07e3dd1b1349a97325c32529d9c3261481eda7e98541e0d079a0e/deciphon-1.0.3.tar.gz",
"platform": null,
"description": "# Welcome to deciphon \ud83d\udc4b\n\n> Individually annotate long, error-prone nucleotide sequences into proteins\n\n### \ud83c\udfe0 [Homepage](https://github.com/EBI-Metagenomics/deciphon-py)\n\n## \u26a1\ufe0f Requirements\n\n- Python >= 3.9\n- Pip\n- [Podman](https://podman.io) >= 3.4\n- [Homebrew](https://brew.sh) on MacOS (recommended)\n- [Pipx](https://pypa.github.io/pipx/) for Python package management (recommended)\n\n### MacOS\n\nInstall Python and Podman:\n\n```sh\nbrew update && brew install python podman pipx\n```\n\nEnsure that your `PATH` environment variable is all set:\n\n```sh\npipx ensurepath\n```\n\n\ud83d\udca1 You might need to close your terminal and reopen it for the changes to take effect.\n\n### Ubuntu (and Debian-based distros)\n\nInstall Python and Podman:\n\n```sh\nsudo apt update && \\\n sudo apt install python3 python3-pip python3-venv podman --yes && \\\n python3 -m pip install --user pipx\n```\n\nEnsure that your `PATH` environment variable is all set:\n\n```sh\npython3 -m pipx ensurepath\n```\n\n\ud83d\udca1 You might need to close your terminal and reopen it for the changes to take effect.\n\n## Install\n\n```sh\npipx install deciphon\n```\n\n## Usage\n\n```\n Usage: deci [OPTIONS] COMMAND [ARGS]...\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --version \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 press Press HMM ASCII file into a Deciphon database one. \u2502\n\u2502 scan Annotate nucleotide sequences into proteins a protein database. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n```\n\n## Example\n\nDownload the `minifam.hmm` protein database:\n\n```sh\ncurl -O https://raw.githubusercontent.com/EBI-Metagenomics/deciphon/main/cli/tests/files/minifam.hmm\n```\n\nDownload the `consensus.fna` file of sequences:\n\n```sh\ncurl -O https://raw.githubusercontent.com/EBI-Metagenomics/deciphon/main/cli/tests/files/sequences.fna\n```\n\nPress it (using The Standard Code):\n\n```sh\ndeci press minifam.hmm 1\n```\n\nScan it:\n\n```sh\ndeci scan minifam.hmm sequences.fna\n```\n\nShow it:\n\n```sh\ndeci see sequences.dcs\n```\n\n## \ud83d\udc64 Author\n\n- [Danilo Horta](https://github.com/horta)\n\n## Show your support\n\nGive a \u2b50\ufe0f if this project helped you!\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Individually annotate long, error-prone nucleotide sequences into proteins",
"version": "1.0.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "73c7f188d521ee128ef4ca670a49d3df0cf1bee40e40adb8f37ae0bd2c0af773",
"md5": "1ac052b6c1a31ecc64ca1077f501762a",
"sha256": "25ddbefeea724cf1653d870128b3e153ad984f2c74db3c19f5a254c53236d2ff"
},
"downloads": -1,
"filename": "deciphon-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1ac052b6c1a31ecc64ca1077f501762a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 10120,
"upload_time": "2024-12-02T10:51:07",
"upload_time_iso_8601": "2024-12-02T10:51:07.560427Z",
"url": "https://files.pythonhosted.org/packages/73/c7/f188d521ee128ef4ca670a49d3df0cf1bee40e40adb8f37ae0bd2c0af773/deciphon-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83a06f6ef2a07e3dd1b1349a97325c32529d9c3261481eda7e98541e0d079a0e",
"md5": "427de39fc524397c1ebcb964f5a37971",
"sha256": "f3f3fde7879bc4591a5820e3c780fd25e7fc0fb225ccbbe2c492d791f0bef44f"
},
"downloads": -1,
"filename": "deciphon-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "427de39fc524397c1ebcb964f5a37971",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 7938,
"upload_time": "2024-12-02T10:51:09",
"upload_time_iso_8601": "2024-12-02T10:51:09.040390Z",
"url": "https://files.pythonhosted.org/packages/83/a0/6f6ef2a07e3dd1b1349a97325c32529d9c3261481eda7e98541e0d079a0e/deciphon-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 10:51:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "deciphon"
}
