==========
SubmitCGAP
==========
A file submission tool for CGAP
===============================
.. image:: https://travis-ci.org/dbmi-bgm/SubmitCGAP.svg
:target: https://travis-ci.org/dbmi-bgm/SubmitCGAP
:alt: Build Status
.. image:: https://coveralls.io/repos/github/dbmi-bgm/SubmitCGAP/badge.svg
:target: https://coveralls.io/github/dbmi-bgm/SubmitCGAP
:alt: Coverage
.. image:: https://readthedocs.org/projects/submitcgap/badge/?version=latest
:target: https://submitcgap.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Description
===========
This is a tool for uploading certain kinds of files to CGAP.
Current support is for submission of new cases, family histories, and gene lists.
Installation
============
Installing this system involves these steps:
1. Create, install, and activate a virtual environment.
2. *Only if you are a developer*, install poetry and select the source repository.
Others will not have a source repository to select,
so should skip this step.
3. If you are an end user, do "``pip install submit_cgap``".
Otherwise, do "``make build``".
4. Set up a ``~/.cgap-keys.json`` credentials file.
For detailed information about these installation steps, see
`Installing SubmitCGAP <https://submitcgap.readthedocs.io/en/latest/installation.html>`_.
Testing
=======
To run unit tests, do::
$ make test
Additional notes on testing these scripts for release can be found in
`Testing SubmitCGAP <TESTING.rst>`__.
Getting Started
===============
Once you have finished installing this library into your virtual environment,
you should have access to the ``submit-metadata-bundle`` and the ``submit-genelist``
commands. For more information about how to format files for submission and how to
use these commands, see `Getting Started <https://submitcgap.readthedocs.io/en/latest/usage.html>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/dbmi-bgm/SubmitCGAP",
"name": "submit-cgap",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.0,<3.10",
"maintainer_email": "",
"keywords": "submit cgap,submitcgap",
"author": "4DN-DCIC Team",
"author_email": "support@4dnucleome.org",
"download_url": "https://files.pythonhosted.org/packages/6d/f6/7feaf92494b452262f4506d9c6b5b8bd2683e6e69f25687a7ad894cff393/submit_cgap-4.1.2.tar.gz",
"platform": null,
"description": "==========\nSubmitCGAP\n==========\n\n\nA file submission tool for CGAP\n===============================\n\n.. image:: https://travis-ci.org/dbmi-bgm/SubmitCGAP.svg\n :target: https://travis-ci.org/dbmi-bgm/SubmitCGAP\n :alt: Build Status\n\n.. image:: https://coveralls.io/repos/github/dbmi-bgm/SubmitCGAP/badge.svg\n :target: https://coveralls.io/github/dbmi-bgm/SubmitCGAP\n :alt: Coverage\n\n.. image:: https://readthedocs.org/projects/submitcgap/badge/?version=latest\n :target: https://submitcgap.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\nDescription\n===========\n\nThis is a tool for uploading certain kinds of files to CGAP.\n\nCurrent support is for submission of new cases, family histories, and gene lists.\n\n\nInstallation\n============\n\nInstalling this system involves these steps:\n\n1. Create, install, and activate a virtual environment.\n2. *Only if you are a developer*, install poetry and select the source repository.\n Others will not have a source repository to select,\n so should skip this step.\n3. If you are an end user, do \"``pip install submit_cgap``\".\n Otherwise, do \"``make build``\".\n4. Set up a ``~/.cgap-keys.json`` credentials file.\n\nFor detailed information about these installation steps, see\n`Installing SubmitCGAP <https://submitcgap.readthedocs.io/en/latest/installation.html>`_.\n\n\nTesting\n=======\n\nTo run unit tests, do::\n\n $ make test\n\nAdditional notes on testing these scripts for release can be found in\n`Testing SubmitCGAP <TESTING.rst>`__.\n\n\nGetting Started\n===============\n\nOnce you have finished installing this library into your virtual environment,\nyou should have access to the ``submit-metadata-bundle`` and the ``submit-genelist``\ncommands. For more information about how to format files for submission and how to\nuse these commands, see `Getting Started <https://submitcgap.readthedocs.io/en/latest/usage.html>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Support for uploading file submissions to the Clinical Genomics Analysis Platform (CGAP).",
"version": "4.1.2",
"project_urls": {
"Homepage": "https://github.com/dbmi-bgm/SubmitCGAP",
"Repository": "https://github.com/dbmi-bgm/SubmitCGAP.git"
},
"split_keywords": [
"submit cgap",
"submitcgap"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "250725233b444f8f4a18158837d69b6ecca6b6f3a8746ac2f1d9d2914e9ede66",
"md5": "7816f5e56a1fde958a7b7006d740ff73",
"sha256": "e4780e3a2e3c05f4af71f4ad1a56c95dd09be4dce28355957c1ca4b40885d62a"
},
"downloads": -1,
"filename": "submit_cgap-4.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7816f5e56a1fde958a7b7006d740ff73",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0,<3.10",
"size": 108855,
"upload_time": "2023-11-21T18:51:27",
"upload_time_iso_8601": "2023-11-21T18:51:27.194443Z",
"url": "https://files.pythonhosted.org/packages/25/07/25233b444f8f4a18158837d69b6ecca6b6f3a8746ac2f1d9d2914e9ede66/submit_cgap-4.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6df67feaf92494b452262f4506d9c6b5b8bd2683e6e69f25687a7ad894cff393",
"md5": "1734c18dfa86a49b98b8390b4d4c1d5e",
"sha256": "94887343edd836cd84e85699370f79a7dd915850209c427aaa17e34cc022c239"
},
"downloads": -1,
"filename": "submit_cgap-4.1.2.tar.gz",
"has_sig": false,
"md5_digest": "1734c18dfa86a49b98b8390b4d4c1d5e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0,<3.10",
"size": 80472,
"upload_time": "2023-11-21T18:51:28",
"upload_time_iso_8601": "2023-11-21T18:51:28.954895Z",
"url": "https://files.pythonhosted.org/packages/6d/f6/7feaf92494b452262f4506d9c6b5b8bd2683e6e69f25687a7ad894cff393/submit_cgap-4.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-21 18:51:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dbmi-bgm",
"github_project": "SubmitCGAP",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "submit-cgap"
}
JSON
