Metadata-Version: 2.1
Name: cpg-utils
Version: 4.6.2
Summary: Library of convenience functions specific to the CPG
Home-page: https://github.com/populationgenomics/cpg-utils
License: MIT
Keywords: bioinformatics
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Description-Content-Type: text/markdown
License-File: LICENSE

# 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='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)
