.. image:: docs/source/_static/images/submitr-banner.png
:target: https://pypi.org/project/submitr/
:alt: SMaHT remote Metadata Submission Tool: submitr
:align: center
|
**THIS IS A PRE-RELEASE VERSION.**
This was recently forked from SubmitCGAP and is not yet ready for normal use.
Watch for version 1.0.
------------
=======
submitr
=======
A file submission tool for SMAHT
================================
.. image:: https://github.com/smaht-dac/submitr/actions/workflows/main.yml/badge.svg
:target: https://github.com/smaht-dac/submitr/actions
:alt: Build Status
.. image:: https://coveralls.io/repos/github/smaht-dac/submitr/badge.svg
:target: https://coveralls.io/github/smaht-dac/submitr
:alt: Coverage Percentage
.. image:: https://readthedocs.org/projects/submitr/badge/?version=latest
:target: https://submitr.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Description
===========
This is a tool for uploading certain kinds of files to SMaHT.
The "R" is for Remote file submission. You can think of this tool as putting the "R" in "SMaHT". :)
Background
==========
This tool was forked from SubmitCGAP and will probably remain compatible, but by forking it, the original repository will remain stable and this new repository can experiment safely.
Because SubmitCGAP supported submission of new cases, family histories, and gene lists, that's what this begins with. But that doesn't imply that those things are present in SMaHT. The protocol is designed to require both ends to agree on the availability of a particular kind of upload for it to happen.
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 submitr``".
Otherwise, do "``make build``".
4. Set up a ``~/.smaht-keys.json`` credentials file.
See detailed information about these installation steps at
`Installing submitr <https://submitr.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 submitr <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://submitr.readthedocs.io/en/latest/getting_started.html>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/smaht-dac/submitr",
"name": "submitr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.0,<3.10",
"maintainer_email": "",
"keywords": "submitr,smaht",
"author": "4DN-DCIC Team",
"author_email": "support@4dnucleome.org",
"download_url": "https://files.pythonhosted.org/packages/2f/45/5e29585e441dd5e7882b870a7a84737f03f1b744ff71287faee8706dc81a/submitr-0.3.4.tar.gz",
"platform": null,
"description": "\n.. image:: docs/source/_static/images/submitr-banner.png\n :target: https://pypi.org/project/submitr/\n :alt: SMaHT remote Metadata Submission Tool: submitr\n :align: center\n\n|\n\n**THIS IS A PRE-RELEASE VERSION.**\n\nThis was recently forked from SubmitCGAP and is not yet ready for normal use.\n\nWatch for version 1.0.\n\n------------\n\n=======\nsubmitr\n=======\n\n\nA file submission tool for SMAHT\n================================\n\n.. image:: https://github.com/smaht-dac/submitr/actions/workflows/main.yml/badge.svg\n :target: https://github.com/smaht-dac/submitr/actions\n :alt: Build Status\n\n.. image:: https://coveralls.io/repos/github/smaht-dac/submitr/badge.svg\n :target: https://coveralls.io/github/smaht-dac/submitr\n :alt: Coverage Percentage\n\n.. image:: https://readthedocs.org/projects/submitr/badge/?version=latest\n :target: https://submitr.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n\nDescription\n===========\n\nThis is a tool for uploading certain kinds of files to SMaHT.\n\nThe \"R\" is for Remote file submission. You can think of this tool as putting the \"R\" in \"SMaHT\". :)\n\n\nBackground\n==========\n\nThis tool was forked from SubmitCGAP and will probably remain compatible, but by forking it, the original repository will remain stable and this new repository can experiment safely.\n\nBecause SubmitCGAP supported submission of new cases, family histories, and gene lists, that's what this begins with. But that doesn't imply that those things are present in SMaHT. The protocol is designed to require both ends to agree on the availability of a particular kind of upload for it to happen.\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 submitr``\".\n Otherwise, do \"``make build``\".\n4. Set up a ``~/.smaht-keys.json`` credentials file.\n\nSee detailed information about these installation steps at\n`Installing submitr <https://submitr.readthedocs.io/en/latest/installation.html>`_.\n\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 submitr <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://submitr.readthedocs.io/en/latest/getting_started.html>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Support for uploading file submissions to SMAHT.",
"version": "0.3.4",
"project_urls": {
"Homepage": "https://github.com/smaht-dac/submitr",
"Repository": "https://github.com/smaht-dac/submitr.git"
},
"split_keywords": [
"submitr",
"smaht"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06e010cb1521fabeaf68ac298a9c0407b664b9f0c0eaacbfdca7724083b436cf",
"md5": "d69b23ed493f09e6d0426f11cfc01d11",
"sha256": "a7b1bb48bf046cff92a042777b2fdf57434ae024b7716ca337db6aaf208bff38"
},
"downloads": -1,
"filename": "submitr-0.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d69b23ed493f09e6d0426f11cfc01d11",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0,<3.10",
"size": 108435,
"upload_time": "2023-09-26T21:57:12",
"upload_time_iso_8601": "2023-09-26T21:57:12.388444Z",
"url": "https://files.pythonhosted.org/packages/06/e0/10cb1521fabeaf68ac298a9c0407b664b9f0c0eaacbfdca7724083b436cf/submitr-0.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2f455e29585e441dd5e7882b870a7a84737f03f1b744ff71287faee8706dc81a",
"md5": "cbe642a5012dc8743b2828e9ceb3ae57",
"sha256": "c9c76ad960715415091ee426b8e457a6e1bbbb3b2883513c1977fe81a76a88c8"
},
"downloads": -1,
"filename": "submitr-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "cbe642a5012dc8743b2828e9ceb3ae57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0,<3.10",
"size": 82123,
"upload_time": "2023-09-26T21:57:13",
"upload_time_iso_8601": "2023-09-26T21:57:13.665353Z",
"url": "https://files.pythonhosted.org/packages/2f/45/5e29585e441dd5e7882b870a7a84737f03f1b744ff71287faee8706dc81a/submitr-0.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-26 21:57:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "smaht-dac",
"github_project": "submitr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "submitr"
}
JSON
