# ncbi_datasets_util
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
This file will become your README and also the index of your
documentation.
## Developer Guide
If you are new to using `nbdev` here are some useful pointers to get you
started.
### Install ncbi_datasets_util in Development mode
``` sh
# make sure ncbi_datasets_util package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to ncbi_datasets_util
$ nbdev_prepare
```
## Usage
### Installation
Install latest from the GitHub
[repository](https://github.com/$GIT_USER_NAME/ncbi_datasets_util):
``` sh
$ pip install git+https://github.com/$GIT_USER_NAME/ncbi_datasets_util.git
```
or from [conda](https://anaconda.org/$GIT_USER_NAME/ncbi_datasets_util)
``` sh
$ conda install -c $GIT_USER_NAME ncbi_datasets_util
```
or from [pypi](https://pypi.org/project/ncbi_datasets_util/)
``` sh
$ pip install ncbi_datasets_util
```
If ncbi-datasets-cli does not run properly, install from conda
``` sh
$ conda install bioconda:ncbi-datasets-cli
```
### Documentation
Documentation can be found hosted on this GitHub
[repository](https://github.com/$GIT_USER_NAME/ncbi_datasets_util)’s
[pages](https://$GIT_USER_NAME.github.io/ncbi_datasets_util/).
Additionally you can find package manager specific guidelines on
[conda](https://anaconda.org/$GIT_USER_NAME/ncbi_datasets_util) and
[pypi](https://pypi.org/project/ncbi_datasets_util/) respectively.
## How to use
Fill me in please! Don’t forget code examples:
### Usage
#### To download all genome data for a specific taxon
!ncbi_download -h
!ncbi_qc_summary -h
!ncbi_download_and_qc -h
``` python
1+1
```
2
Raw data
{
"_id": null,
"home_page": "https://github.com/$GIT_USER_NAME/ncbi_datasets_util",
"name": "ncbi-datasets-util",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "$GIT_USER_NAME",
"author_email": "thej@ssi.dk",
"download_url": "https://files.pythonhosted.org/packages/df/f4/6d72fdb586773806649e813cd174c1bb93f77908e2f3cedbf2a42f084907/ncbi_datasets_util-0.3.0.tar.gz",
"platform": null,
"description": "# ncbi_datasets_util\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\nThis file will become your README and also the index of your\ndocumentation.\n\n## Developer Guide\n\nIf you are new to using `nbdev` here are some useful pointers to get you\nstarted.\n\n### Install ncbi_datasets_util in Development mode\n\n``` sh\n# make sure ncbi_datasets_util package is installed in development mode\n$ pip install -e .\n\n# make changes under nbs/ directory\n# ...\n\n# compile to have changes apply to ncbi_datasets_util\n$ nbdev_prepare\n```\n\n## Usage\n\n### Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/$GIT_USER_NAME/ncbi_datasets_util):\n\n``` sh\n$ pip install git+https://github.com/$GIT_USER_NAME/ncbi_datasets_util.git\n```\n\nor from [conda](https://anaconda.org/$GIT_USER_NAME/ncbi_datasets_util)\n\n``` sh\n$ conda install -c $GIT_USER_NAME ncbi_datasets_util\n```\n\nor from [pypi](https://pypi.org/project/ncbi_datasets_util/)\n\n``` sh\n$ pip install ncbi_datasets_util\n```\n\nIf ncbi-datasets-cli does not run properly, install from conda\n\n``` sh\n$ conda install bioconda:ncbi-datasets-cli\n```\n\n### Documentation\n\nDocumentation can be found hosted on this GitHub\n[repository](https://github.com/$GIT_USER_NAME/ncbi_datasets_util)\u2019s\n[pages](https://$GIT_USER_NAME.github.io/ncbi_datasets_util/).\nAdditionally you can find package manager specific guidelines on\n[conda](https://anaconda.org/$GIT_USER_NAME/ncbi_datasets_util) and\n[pypi](https://pypi.org/project/ncbi_datasets_util/) respectively.\n\n## How to use\n\nFill me in please! Don\u2019t forget code examples:\n\n### Usage\n\n#### To download all genome data for a specific taxon\n\n!ncbi_download -h\n\n!ncbi_qc_summary -h\n\n!ncbi_download_and_qc -h\n\n``` python\n1+1\n```\n\n 2\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "TODO",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/$GIT_USER_NAME/ncbi_datasets_util"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5a1ff5ab6a0ec94931e9817e4227ca2e09079491b76bf20e95a0dd04081f4abb",
"md5": "171d88e207bf6b80fb6b80de01fdaa6c",
"sha256": "3e2376b8555c29a7e361254d812c4788ee6b58f866eecc5c5f664fe91a147c16"
},
"downloads": -1,
"filename": "ncbi_datasets_util-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "171d88e207bf6b80fb6b80de01fdaa6c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 29546,
"upload_time": "2025-02-04T15:33:34",
"upload_time_iso_8601": "2025-02-04T15:33:34.977110Z",
"url": "https://files.pythonhosted.org/packages/5a/1f/f5ab6a0ec94931e9817e4227ca2e09079491b76bf20e95a0dd04081f4abb/ncbi_datasets_util-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dff46d72fdb586773806649e813cd174c1bb93f77908e2f3cedbf2a42f084907",
"md5": "09dace0e6d7f734d0e8619fe3dbb8024",
"sha256": "c96cb101630949a077194444eca481319ca9599bcd2a2f05c7e729ece66538f4"
},
"downloads": -1,
"filename": "ncbi_datasets_util-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "09dace0e6d7f734d0e8619fe3dbb8024",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 20480,
"upload_time": "2025-02-04T15:33:36",
"upload_time_iso_8601": "2025-02-04T15:33:36.022695Z",
"url": "https://files.pythonhosted.org/packages/df/f4/6d72fdb586773806649e813cd174c1bb93f77908e2f3cedbf2a42f084907/ncbi_datasets_util-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-04 15:33:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "$GIT_USER_NAME",
"github_project": "ncbi_datasets_util",
"github_not_found": true,
"lcname": "ncbi-datasets-util"
}
JSON
