# dbnomics-fetcher-toolbox
Toolbox of functions and data types helping writing DBnomics fetchers.
[](https://dbnomics-fetcher-toolbox.readthedocs.io/en/latest/?badge=latest)
## Installation
If you're using this package, you may be working on a DBnomics fetcher.
In that case, just add the `dbnomics-fetcher-toolbox` package to your requirements file.
Example using [pip-tools](https://github.com/jazzband/pip-tools) in a Python [virtual environment](https://docs.python.org/3/library/venv.html).
```bash
# Create a Python virtual environment
python -m venv my-fetcher
# Activate the virtual environment
source my-fetcher/bin/activate
# Install dependencies management tool
pip install pip-tools
# Declare dependency
echo dbnomics-fetcher-toolbox >> requirements.in
# Freeze dependencies
pip-compile
# Synchronize the virtual environment with frozen dependencies
pip-sync
```
Note: this workflow is quite complex due to the Python ecosystem which does not define a standard way to manage dependencies.
You can use another packaging tool like [poetry](https://python-poetry.org/).
## Documentation
See https://dbnomics-fetcher-toolbox.readthedocs.io/
## Contributing
### Documentation
To contribute to the documentation, install:
```
pip install --editable .[doc]
pip install sphinx-autobuild
```
Then launch:
```
sphinx-autobuild --watch dbnomics_fetcher_toolbox doc doc/_build/html
```
Raw data
{
"_id": null,
"home_page": "https://git.nomics.world/dbnomics/dbnomics-fetcher-toolbox",
"name": "dbnomics-fetcher-toolbox",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "DBnomics Team",
"author_email": "contact@nomics.world",
"download_url": "https://files.pythonhosted.org/packages/9e/01/3feca7d7cf1ef10b2bea3ac2c7217207de30d827b23c58fc54393a842261/dbnomics-fetcher-toolbox-0.0.9.tar.gz",
"platform": "",
"description": "# dbnomics-fetcher-toolbox\n\nToolbox of functions and data types helping writing DBnomics fetchers.\n\n[](https://dbnomics-fetcher-toolbox.readthedocs.io/en/latest/?badge=latest)\n\n## Installation\n\nIf you're using this package, you may be working on a DBnomics fetcher.\nIn that case, just add the `dbnomics-fetcher-toolbox` package to your requirements file.\n\nExample using [pip-tools](https://github.com/jazzband/pip-tools) in a Python [virtual environment](https://docs.python.org/3/library/venv.html).\n\n```bash\n# Create a Python virtual environment\npython -m venv my-fetcher\n\n# Activate the virtual environment\nsource my-fetcher/bin/activate\n\n# Install dependencies management tool\npip install pip-tools\n\n# Declare dependency\necho dbnomics-fetcher-toolbox >> requirements.in\n\n# Freeze dependencies\npip-compile\n\n# Synchronize the virtual environment with frozen dependencies\npip-sync\n```\n\nNote: this workflow is quite complex due to the Python ecosystem which does not define a standard way to manage dependencies.\nYou can use another packaging tool like [poetry](https://python-poetry.org/).\n\n## Documentation\n\nSee https://dbnomics-fetcher-toolbox.readthedocs.io/\n\n## Contributing\n\n### Documentation\n\nTo contribute to the documentation, install:\n\n```\npip install --editable .[doc]\npip install sphinx-autobuild\n```\n\nThen launch:\n\n```\nsphinx-autobuild --watch dbnomics_fetcher_toolbox doc doc/_build/html\n```\n\n\n",
"bugtrack_url": null,
"license": "AGPLv3+",
"summary": "Toolbox of functions and data types helping writing DBnomics fetchers.",
"version": "0.0.9",
"project_urls": {
"ChangeLog": "https://git.nomics.world/dbnomics/dbnomics-fetcher-toolbox/blob/master/CHANGELOG.md",
"Documentation": "https://dbnomics-fetcher-toolbox.readthedocs.io/",
"Homepage": "https://git.nomics.world/dbnomics/dbnomics-fetcher-toolbox"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "efed1716b5b492e6cade069a4bbd1c3af3f2dc47a00f883cefe17f70c7aba7b6",
"md5": "cc34f66b12f67bd2259ae5b31f28178b",
"sha256": "909a16e817f6330b41a2231b0f05d96a96f2b82e643da1b9f4e41e407a18e236"
},
"downloads": -1,
"filename": "dbnomics_fetcher_toolbox-0.0.9-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc34f66b12f67bd2259ae5b31f28178b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 43341,
"upload_time": "2020-10-05T08:00:50",
"upload_time_iso_8601": "2020-10-05T08:00:50.069674Z",
"url": "https://files.pythonhosted.org/packages/ef/ed/1716b5b492e6cade069a4bbd1c3af3f2dc47a00f883cefe17f70c7aba7b6/dbnomics_fetcher_toolbox-0.0.9-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e013feca7d7cf1ef10b2bea3ac2c7217207de30d827b23c58fc54393a842261",
"md5": "2bc787e9d858e24081366d8ffd59cf54",
"sha256": "6d05122caf4d7d2a3937ad5ea3f26b50863346362806e5ac2c84152dce7798c6"
},
"downloads": -1,
"filename": "dbnomics-fetcher-toolbox-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "2bc787e9d858e24081366d8ffd59cf54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 46164,
"upload_time": "2020-10-05T08:00:51",
"upload_time_iso_8601": "2020-10-05T08:00:51.501459Z",
"url": "https://files.pythonhosted.org/packages/9e/01/3feca7d7cf1ef10b2bea3ac2c7217207de30d827b23c58fc54393a842261/dbnomics-fetcher-toolbox-0.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-10-05 08:00:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "dbnomics-fetcher-toolbox"
}
JSON