py-gfe


Namepy-gfe JSON
Version 1.1.6 PyPI version JSON
download
home_pagehttps://github.com/nmdp-bioinformatics/py-gfe
SummaryPython package for converting sequence annotations to gene feature enumerations (GFE).
upload_time2023-12-11 15:30:36
maintainer
docs_urlNone
authorCIBMTR
requires_python
licenseLGPL 3.0
keywords pygfe
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            ===============================
py-gfe
===============================


.. image:: https://img.shields.io/pypi/v/pygfe.svg
        :target: https://pypi.python.org/pypi/pygfe

.. image:: https://img.shields.io/travis/mhalagan-nmdp/pygfe.svg
        :target: https://travis-ci.org/mhalagan-nmdp/pygfe

.. image:: https://readthedocs.org/projects/pygfe/badge/?version=latest
        :target: https://pygfe.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/mhalagan-nmdp/pygfe/shield.svg
     :target: https://pyup.io/repos/github/mhalagan-nmdp/pygfe/
     :alt: Updates


Python Boilerplate contains all the boilerplate you need to create a Python package.


* Free software: LGPL 3.0
* Documentation: https://pygfe.readthedocs.io.

Docker
--------

.. code-block:: shell

  docker pull nmdpbioinformatics/py-gfe

.. code-block:: 

	docker run -it --rm -v $PWD:/opt nmdpbioinformatics/py-gfe seq2gfe \
		-f /opt/your_fastafile.fasta -l HLA-A


Example
--------

.. code-block:: python3

    >>> from Bio import SeqIO
    >>> from BioSQL import BioSeqDatabase
    >>> from seqann.sequence_annotation import BioSeqAnn
    >>> import pygfe
    >>> seq_file = 'test_dq.fasta'
    >>> gfe = pygfe.pyGFE()
    >>> server = BioSeqDatabase.open_database(driver="pymysql", user="root",
    ...                                       passwd="", host="localhost",
    ...                                      db="bioseqdb")
    >>> seqann = BioSeqAnn(server=server)
    >>> seq_rec = list(SeqIO.parse(seq_file, 'fasta'))[0]
    >>> annotation = seqann.annotate(seq_rec, "HLA-DQB1")
    >>> gfe = gfe.get_gfe(annotation, "HLA-DQB1")
    >>> print(gfe)
    HLA-DQB1w0-4-0-141-0-12-0-4-0-0-0-0-0

Credits
---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage



=======
History
=======

0.0.1 (2017-11-09)
------------------

* First release on PyPI.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nmdp-bioinformatics/py-gfe",
    "name": "py-gfe",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "pygfe",
    "author": "CIBMTR",
    "author_email": "cibmtr-pypi@nmdp.org",
    "download_url": "https://files.pythonhosted.org/packages/59/4a/029fd972c9771e453d0d4d26a2b81f1114c08fa1c1e2b873931a2173974e/py-gfe-1.1.6.tar.gz",
    "platform": null,
    "description": "===============================\npy-gfe\n===============================\n\n\n.. image:: https://img.shields.io/pypi/v/pygfe.svg\n        :target: https://pypi.python.org/pypi/pygfe\n\n.. image:: https://img.shields.io/travis/mhalagan-nmdp/pygfe.svg\n        :target: https://travis-ci.org/mhalagan-nmdp/pygfe\n\n.. image:: https://readthedocs.org/projects/pygfe/badge/?version=latest\n        :target: https://pygfe.readthedocs.io/en/latest/?badge=latest\n        :alt: Documentation Status\n\n.. image:: https://pyup.io/repos/github/mhalagan-nmdp/pygfe/shield.svg\n     :target: https://pyup.io/repos/github/mhalagan-nmdp/pygfe/\n     :alt: Updates\n\n\nPython Boilerplate contains all the boilerplate you need to create a Python package.\n\n\n* Free software: LGPL 3.0\n* Documentation: https://pygfe.readthedocs.io.\n\nDocker\n--------\n\n.. code-block:: shell\n\n  docker pull nmdpbioinformatics/py-gfe\n\n.. code-block:: \n\n\tdocker run -it --rm -v $PWD:/opt nmdpbioinformatics/py-gfe seq2gfe \\\n\t\t-f /opt/your_fastafile.fasta -l HLA-A\n\n\nExample\n--------\n\n.. code-block:: python3\n\n    >>> from Bio import SeqIO\n    >>> from BioSQL import BioSeqDatabase\n    >>> from seqann.sequence_annotation import BioSeqAnn\n    >>> import pygfe\n    >>> seq_file = 'test_dq.fasta'\n    >>> gfe = pygfe.pyGFE()\n    >>> server = BioSeqDatabase.open_database(driver=\"pymysql\", user=\"root\",\n    ...                                       passwd=\"\", host=\"localhost\",\n    ...                                      db=\"bioseqdb\")\n    >>> seqann = BioSeqAnn(server=server)\n    >>> seq_rec = list(SeqIO.parse(seq_file, 'fasta'))[0]\n    >>> annotation = seqann.annotate(seq_rec, \"HLA-DQB1\")\n    >>> gfe = gfe.get_gfe(annotation, \"HLA-DQB1\")\n    >>> print(gfe)\n    HLA-DQB1w0-4-0-141-0-12-0-4-0-0-0-0-0\n\nCredits\n---------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n\n=======\nHistory\n=======\n\n0.0.1 (2017-11-09)\n------------------\n\n* First release on PyPI.\n\n",
    "bugtrack_url": null,
    "license": "LGPL 3.0",
    "summary": "Python package for converting sequence annotations to gene feature enumerations (GFE).",
    "version": "1.1.6",
    "project_urls": {
        "Homepage": "https://github.com/nmdp-bioinformatics/py-gfe"
    },
    "split_keywords": [
        "pygfe"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8177ba7065ac0cccaafd71f2ac3d424814e9cc1914aeeddc8a97b1db6cbcbe45",
                "md5": "1b13968d7c58d22c37806605980e2e6e",
                "sha256": "69f2a929cdd5f0314f48a5d604afbdf6e0016a445156c31dcce5c2baa15424cb"
            },
            "downloads": -1,
            "filename": "py_gfe-1.1.6-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1b13968d7c58d22c37806605980e2e6e",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 64878,
            "upload_time": "2023-12-11T15:30:34",
            "upload_time_iso_8601": "2023-12-11T15:30:34.160203Z",
            "url": "https://files.pythonhosted.org/packages/81/77/ba7065ac0cccaafd71f2ac3d424814e9cc1914aeeddc8a97b1db6cbcbe45/py_gfe-1.1.6-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "594a029fd972c9771e453d0d4d26a2b81f1114c08fa1c1e2b873931a2173974e",
                "md5": "8e5a7a0fb50c5af7e4d4f2e14b2aa1ac",
                "sha256": "d77a7df73e3b789bb2f72a39afc31dd6d2864aed857aad44d22293288f825f2a"
            },
            "downloads": -1,
            "filename": "py-gfe-1.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "8e5a7a0fb50c5af7e4d4f2e14b2aa1ac",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 70592,
            "upload_time": "2023-12-11T15:30:36",
            "upload_time_iso_8601": "2023-12-11T15:30:36.729316Z",
            "url": "https://files.pythonhosted.org/packages/59/4a/029fd972c9771e453d0d4d26a2b81f1114c08fa1c1e2b873931a2173974e/py-gfe-1.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-11 15:30:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nmdp-bioinformatics",
    "github_project": "py-gfe",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "py-gfe"
}
        
Elapsed time: 3.31125s