h3daemon


Nameh3daemon JSON
Version 2.0.1 PyPI version JSON
download
home_pageNone
SummaryHMMER server
upload_time2025-01-22 22:14:41
maintainerNone
docs_urlNone
authorNone
requires_python~=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Welcome to h3daemon 👋

> Command-line for running HMMER server on arm64 and amd64 machines.

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

## ⚡️ Requirements

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

### MacOS

Install Python and Pipx:

```sh
brew update && brew install python 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 Pipx:

```sh
sudo apt update && \
    sudo apt install python3 python3-pip python3-venv --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 h3daemon
```

## Usage

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

╭─ Options ─────────────────────────────────────────────────────╮
│ --version                                                     │
│ --help             Show this message and exit.                │
╰───────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────╮
│ start                 Start daemon.                           │
│ stop                  Stop daemon.                            │
╰───────────────────────────────────────────────────────────────╯
```

### Example

Download `minifam.hmm` database:

```sh
pipx run blx get \
  fe305d9c09e123f987f49b9056e34c374e085d8831f815cc73d8ea4cdec84960 \
  minifam.hmm
```

Press it:

```sh
pipx run --spec hmmer hmmpress minifam.hmm
```

Start the daemon to listen on a random (available) port:

```sh
h3daemon start minifam.hmm
```

And stop it:

```sh
h3daemon stop minifam.hmm
```

## 👤 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": "h3daemon",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "~=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Danilo Horta <horta@ebi.ac.uk>",
    "download_url": "https://files.pythonhosted.org/packages/e6/bb/99098e961475f6994ea94ecb6b9bb7a95b3f3a762fd86c7235edaf046b88/h3daemon-2.0.1.tar.gz",
    "platform": null,
    "description": "# Welcome to h3daemon \ud83d\udc4b\n\n> Command-line for running HMMER server on arm64 and amd64 machines.\n\n### \ud83c\udfe0 [Homepage](https://github.com/EBI-Metagenomics/h3daemon)\n\n## \u26a1\ufe0f Requirements\n\n- Python >= 3.9\n- Pip\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 Pipx:\n\n```sh\nbrew update && brew install python 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 Pipx:\n\n```sh\nsudo apt update && \\\n    sudo apt install python3 python3-pip python3-venv --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## \ud83d\udce6 Install\n\n```sh\npipx install h3daemon\n```\n\n## Usage\n\n```\n Usage: h3daemon [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\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\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\u256e\n\u2502 start                 Start daemon.                           \u2502\n\u2502 stop                  Stop daemon.                            \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\u256f\n```\n\n### Example\n\nDownload `minifam.hmm` database:\n\n```sh\npipx run blx get \\\n  fe305d9c09e123f987f49b9056e34c374e085d8831f815cc73d8ea4cdec84960 \\\n  minifam.hmm\n```\n\nPress it:\n\n```sh\npipx run --spec hmmer hmmpress minifam.hmm\n```\n\nStart the daemon to listen on a random (available) port:\n\n```sh\nh3daemon start minifam.hmm\n```\n\nAnd stop it:\n\n```sh\nh3daemon stop minifam.hmm\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",
    "bugtrack_url": null,
    "license": null,
    "summary": "HMMER server",
    "version": "2.0.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "207d49917a44f4c6911a74f4e384597f04542ca23653c618bcc5cd5918900511",
                "md5": "b8e29757a44dbc6bbed2e31b73375722",
                "sha256": "6c8751e9566015617f4e7a6df451b1b07faa4483b3308c7a6650e249bca26a7b"
            },
            "downloads": -1,
            "filename": "h3daemon-2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b8e29757a44dbc6bbed2e31b73375722",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.9",
            "size": 9861,
            "upload_time": "2025-01-22T22:14:39",
            "upload_time_iso_8601": "2025-01-22T22:14:39.708412Z",
            "url": "https://files.pythonhosted.org/packages/20/7d/49917a44f4c6911a74f4e384597f04542ca23653c618bcc5cd5918900511/h3daemon-2.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e6bb99098e961475f6994ea94ecb6b9bb7a95b3f3a762fd86c7235edaf046b88",
                "md5": "43cf48f60708581fc728ace44a3b94f0",
                "sha256": "253de77b0b4847c047a0153553a58a74daea7ff126336cb5b2725f17365504bc"
            },
            "downloads": -1,
            "filename": "h3daemon-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "43cf48f60708581fc728ace44a3b94f0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.9",
            "size": 66506,
            "upload_time": "2025-01-22T22:14:41",
            "upload_time_iso_8601": "2025-01-22T22:14:41.840467Z",
            "url": "https://files.pythonhosted.org/packages/e6/bb/99098e961475f6994ea94ecb6b9bb7a95b3f3a762fd86c7235edaf046b88/h3daemon-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-22 22:14:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "h3daemon"
}
        
Elapsed time: 1.35319s