# GTDB-Tk Database Download
Minimal toolkit for downloading the GTDB-Tk database to disk.
This is **not the recommended way** to download the GTDB-Tk reference database, please see
[here](https://ecogenomics.github.io/GTDBTk/installing/index.html#gtdb-tk-reference-data) for the reccomended method.
This softare may be useful for users who are experiencing intermittent connection errors, or slow download speeds.
## 📚 Requirements
This software requires Python >=3.8 and makes use of the following packages:
* [requests](https://pypi.org/project/requests/)
* [tqdm](https://pypi.org/project/tqdm/)
* [typer](https://pypi.org/project/typer/)
## ⚙️ Installation
In a new virtual environment, or conda environment that is running Python >=3.8, simply run:
```shell
python -m pip install gtdbtk_db_download
```
## 🚀 Usage
For a complete list of options, run: `gtdbtk_db_download --help`
Example usage downloading to the `/tmp/db` directory:
```shell
gtdbtk_db_download /tmp/db --threads 10
```
### Example output
```text
[2023-06-16 13:51:41] - gtdbtk_downloader v1.0.0
[2023-06-16 13:51:41] - Creating output directory.
[2023-06-16 13:51:41] - Loading R214 manifest
[2023-06-16 13:51:42] - Creating queue
[2023-06-16 13:51:42] - Downloading files
[2023-06-16 16:00:00] - Done.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Ecogenomics/gtdbtk-db-download",
"name": "gtdbtk-db-download",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Aaron Mussig",
"author_email": "aaronmussig@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a9/33/b1b4adf38658c51691a73f6715133b409efdf9f25b7651e56dcacd3a4f99/gtdbtk_db_download-1.0.1.tar.gz",
"platform": null,
"description": "# GTDB-Tk Database Download\n\nMinimal toolkit for downloading the GTDB-Tk database to disk.\n\nThis is **not the recommended way** to download the GTDB-Tk reference database, please see \n[here](https://ecogenomics.github.io/GTDBTk/installing/index.html#gtdb-tk-reference-data) for the reccomended method.\n\nThis softare may be useful for users who are experiencing intermittent connection errors, or slow download speeds.\n\n## \ud83d\udcda Requirements\n\nThis software requires Python >=3.8 and makes use of the following packages:\n\n* [requests](https://pypi.org/project/requests/)\n* [tqdm](https://pypi.org/project/tqdm/)\n* [typer](https://pypi.org/project/typer/)\n\n## \u2699\ufe0f Installation\n\nIn a new virtual environment, or conda environment that is running Python >=3.8, simply run:\n\n```shell\npython -m pip install gtdbtk_db_download\n```\n\n## \ud83d\ude80 Usage\n\nFor a complete list of options, run: `gtdbtk_db_download --help`\n\nExample usage downloading to the `/tmp/db` directory:\n\n```shell\ngtdbtk_db_download /tmp/db --threads 10\n```\n\n### Example output\n\n```text\n[2023-06-16 13:51:41] - gtdbtk_downloader v1.0.0\n[2023-06-16 13:51:41] - Creating output directory.\n[2023-06-16 13:51:41] - Loading R214 manifest\n[2023-06-16 13:51:42] - Creating queue\n[2023-06-16 13:51:42] - Downloading files\n[2023-06-16 16:00:00] - Done.\n```\n",
"bugtrack_url": null,
"license": "GNU GPLv3",
"summary": "Minimal toolkit for downloading the GTDB-Tk database to disk.",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/Ecogenomics/gtdbtk-db-download/issues",
"Documentation": "https://github.com/Ecogenomics/gtdbtk-db-download",
"Homepage": "https://github.com/Ecogenomics/gtdbtk-db-download",
"Source Code": "https://github.com/Ecogenomics/gtdbtk-db-download"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a933b1b4adf38658c51691a73f6715133b409efdf9f25b7651e56dcacd3a4f99",
"md5": "863d8e062863f1358dafa8c46be9fa77",
"sha256": "b32b61d6860c0db79903fa2a0f0aac0462acee1b37682c4ee2e02a7ce996b601"
},
"downloads": -1,
"filename": "gtdbtk_db_download-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "863d8e062863f1358dafa8c46be9fa77",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2396718,
"upload_time": "2023-06-16T04:02:10",
"upload_time_iso_8601": "2023-06-16T04:02:10.735249Z",
"url": "https://files.pythonhosted.org/packages/a9/33/b1b4adf38658c51691a73f6715133b409efdf9f25b7651e56dcacd3a4f99/gtdbtk_db_download-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-16 04:02:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ecogenomics",
"github_project": "gtdbtk-db-download",
"github_not_found": true,
"lcname": "gtdbtk-db-download"
}
JSON
