# cpg-utils
This is a Python library containing convenience functions that are specific to the CPG.
In order to install the library in a conda environment, run:
```bash
conda install -c cpg cpg-utils
```
To use the library, import functions like this:
```python
from cpg_utils.cloud import email_from_id_token
_email_string = email_from_id_token(id_token_jwt='TOKEN_STRING')
```
We use `bumpversion` for incrementing the library's semantic version. A new conda package gets published automatically in the `cpg` conda channel whenever a version bump commit is merged with the `main` branch.
## Contents
- [Methods to facilitate cloud computing](documentation/cloud.md)
- [Helper functions for Hail Batch jobs](documentation/hail_batch.md)
- [Cloning git repositories inside Hail Batch jobs](documentation/git.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/populationgenomics/cpg-utils",
"name": "cpg-utils",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "bioinformatics",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/cb/33/88e1afe128603b3d10221d27e3d3b6ea1dcc38a0518a14467d171189dff5/cpg-utils-5.0.7.tar.gz",
"platform": null,
"description": "# cpg-utils\n\nThis is a Python library containing convenience functions that are specific to the CPG.\n\nIn order to install the library in a conda environment, run:\n\n```bash\nconda install -c cpg cpg-utils\n```\n\nTo use the library, import functions like this:\n\n```python\nfrom cpg_utils.cloud import email_from_id_token\n\n_email_string = email_from_id_token(id_token_jwt='TOKEN_STRING')\n```\n\nWe use `bumpversion` for incrementing the library's semantic version. A new conda package gets published automatically in the `cpg` conda channel whenever a version bump commit is merged with the `main` branch.\n\n\n## Contents\n\n- [Methods to facilitate cloud computing](documentation/cloud.md)\n- [Helper functions for Hail Batch jobs](documentation/hail_batch.md)\n- [Cloning git repositories inside Hail Batch jobs](documentation/git.md)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library of convenience functions specific to the CPG",
"version": "5.0.7",
"project_urls": {
"Homepage": "https://github.com/populationgenomics/cpg-utils"
},
"split_keywords": [
"bioinformatics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb3388e1afe128603b3d10221d27e3d3b6ea1dcc38a0518a14467d171189dff5",
"md5": "86419d909135fe8eb0f9e87e855390cb",
"sha256": "42d9c34ca36e4b3650a13174f4ce38e707ecf3a72d8655c54d2ab13493ee01da"
},
"downloads": -1,
"filename": "cpg-utils-5.0.7.tar.gz",
"has_sig": false,
"md5_digest": "86419d909135fe8eb0f9e87e855390cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 40483,
"upload_time": "2024-04-19T03:50:56",
"upload_time_iso_8601": "2024-04-19T03:50:56.012098Z",
"url": "https://files.pythonhosted.org/packages/cb/33/88e1afe128603b3d10221d27e3d3b6ea1dcc38a0518a14467d171189dff5/cpg-utils-5.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-19 03:50:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "populationgenomics",
"github_project": "cpg-utils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "cpg-utils"
}
JSON
