{ "info": { "author": "F\u00e1bio Madeira", "author_email": "tbrittoborges@dundee.ac.uk", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Internet", "Topic :: Scientific/Engineering :: Bio-Informatics", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "ProteoFAV\n=========\n\n**Protein Feature Aggregation and Variants**\n\n|Pypi| |Build Status| |Documentation| |Python: versions| |License|\n\n.. |Pypi| image:: https://img.shields.io/pypi/v/proteofav.svg\n :target: https://pypi.python.org/pypi/proteofav\n.. |Build Status| image:: https://img.shields.io/travis/bartongroup/proteofav.svg\n :target: https://travis-ci.org/bartongroup/proteofav\n.. |Documentation| image:: https://readthedocs.org/projects/proteofav/badge/?version=latest\n :target: https://proteofav.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. |Coverage Status| image:: https://coveralls.io/repos/github/bartongroup/proteofav/badge.svg?branch=master\n :target: https://coveralls.io/github/bartongroup/proteofav?branch=master\n.. |Health| image:: https://landscape.io/github/bartongroup/proteofav/master/landscape.svg?style=flat\n :target: https://landscape.io/github/bartongroup/proteofav/master\n.. |Pyup| image:: https://pyup.io/repos/github/bartongroup/proteofav/shield.svg\n :target: https://pyup.io/repos/github/bartongroup/proteofav/\n :alt: Updates\n.. |License| image:: http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat\n :target: https://github.com/bartongroup/proteofav//blob/master/LICENSE.md\n.. |Python: versions| image:: https://img.shields.io/badge/python-3.5,_3.6-blue.svg?style=flat\n :target: http://travis-ci.org/bartongroup/proteofav/\n\nProteoFAV is a Python module that address the challenge of cross-mapping protein structures and protein sequences,\nallowing for protein structures to be annotated with sequence features. It implements methods for working with\nprotein structures (via mmCIF, PDB, PDB Validation, DSSP and SIFTS files), sequence Features (via UniProt GFF annotations) and\ngenetic variants (via UniProt/EBI Proteins API and Ensembl REST API). Cross-mapping of structure and sequence is\nperformed with the aid of SIFTS.\n\nProteFAV relies heavily in the `Pandas`_ library to quickly load data into DataFrames for fast\ndata exploration and analysis. Structure and sequence\ndata are parsed/fetched onto Pandas DataFrames that are then merged-together (collapsed) onto a\nsingle DataFrame.\n\nGetting Started\n---------------\n\nDependencies\n~~~~~~~~~~~~\n\nProteoFAV was developed to support Python 3.5+ and Pandas 0.20+.\n\nCheck `requirements`_ for specific requirements.\n\n.. _requirements: https://github.com/bartongroup/ProteoFAV/blob/master/requirements.txt\n\n\nInstallation\n~~~~~~~~~~~~\n\nTo install the stable release, run this command in your terminal:\n\n.. code-block:: console\n\n $ pip install proteofav\n\nIf you don't have `pip`_ installed, this `Python installation guide`_ can guide\nyou through the process.\n\n.. _pip: https://pip.pypa.io\n.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/\n\n\nInstalling from source in a virtual environment\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nGetting ProteoFAV:\n\n.. code-block:: bash\n\n $ wget https://github.com/bartongroup/ProteoFAV/archive/master.zip -O ProteoFAV.zip\n $ unzip ProteoFAV.zip\n\n # alternatively, cloning the git repository\n $ git clone https://github.com/bartongroup/ProteoFAV.git\n\n\nInstalling With Conda:\n\n.. code-block:: bash\n\n $ conda-env create -n proteofav -f path/to/ProteoFAV/requirements.txt\n $ source activate proteofav\n $ cd path/to/ProteoFAV\n $ pip install .\n\nInstalling with Virtualenv:\n\n.. code-block:: bash\n\n $ virtualenv --python `which python` env\n $ source env/bin/activate\n $ pip install -r requirements.txt\n $ python path/to/ProteoFAV/setup.py install\n\n\nTesting the installation\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nTest dependencies should be resolved with:\n\n.. code-block:: bash\n\n $ python path/to/ProteoFAV/setup.py develop --user\n\n\nRun the Tests with:\n\n.. code-block:: bash\n\n $ python path/to/ProteoFAV/setup.py test\n # or\n $ cd path/to/ProteoFAV/tests\n $ python -m unittest discover\n\n\nProteoFAV Configuration\n~~~~~~~~~~~~~~~~~~~~~~~\n\nProteoFAV uses a configuration file `config.ini` where the user can specify the directory paths, as well as urls for commonly used data sources.\n\nAfter installing run:\n\n.. code-block:: bash\n\n $ proteofav-setup\n\n\nExample Usage\n-------------\n\nExample usage is currently provided as a `Jupyter Notebook`, which can be viewed with the `GitHub's`_ file viewer or with the Jupyter `nbviewer`_.\n\nYou can download the Jupyter notebook from `GitHub`_ and test it with your ProteoFAV's installation.\n\n.. _GitHub's: https://github.com/bartongroup/ProteoFAV/blob/master/Examples.ipynb\n.. _nbviewer: https://nbviewer.jupyter.org/github/bartongroup/ProteoFAV/blob/master/Examples.ipynb\n.. _GitHub: https://github.com/bartongroup/ProteoFAV\n\n\nContributing and Bug tracking\n-----------------------------\n\nFeel free to fork, clone, share and distribute. If you find any bugs or\nissues please log them in the `issue tracker`_.\n\nBefore you submit your *Pull-requests* read the `Contributing Guide`_.\n\nCredits\n-------\n\nSee the `Credits`_\n\n\nChangelog\n---------\n\nSee the `Changelog`_\n\n\nLicensing\n---------\n\nThe MIT License (MIT). See `license`_ for details.\n\n.. _requirements: https://github.com/bartongroup/ProteoFAV/blob/master/requirements.txt\n.. _license: https://github.com/bartongroup/ProteoFAV/blob/master/LICENSE.md\n.. _issue tracker: https://github.com/bartongroup/ProteoFAV/issues\n.. _docs: https://github.com/bartongroup/ProteoFAV/blob/master/docs/index.rst\n.. _Pandas: http://pandas.pydata.org/\n.. _Contributing Guide: https://github.com/bartongroup/ProteoFAV/wiki/Contributing-Guide\n.. _Changelog: https://github.com/bartongroup/ProteoFAV/blob/master/CHANGELOG.rst\n.. _Credits: https://github.com/bartongroup/ProteoFAV/blob/master/AUTHORS.rst\n", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/bartongroup/ProteoFAV/archive/master.zip", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/bartongroup/ProteoFAV/tree/master", "keywords": "bioinformatics structural-biology data-analysis python pandas", "license": "LICENSE.md", "maintainer": "", "maintainer_email": "", "name": "proteofav", "package_url": "https://pypi.org/project/proteofav/", "platform": "", "project_url": "https://pypi.org/project/proteofav/", "project_urls": { "Download": "https://github.com/bartongroup/ProteoFAV/archive/master.zip", "Homepage": "https://github.com/bartongroup/ProteoFAV/tree/master" }, "release_url": "https://pypi.org/project/proteofav/0.2.3/", "requires_dist": null, "requires_python": "", "summary": "PROtein Feature Aggregation and Variants.", "version": "0.2.3" }, "last_serial": 3370882, "releases": { "0.2.0b0": [ { "comment_text": "", "digests": { "md5": "b6b14a5b36e5138bcef9967e8546b11f", "sha256": "5ff27f8f70dc51b48be718a6a2b765f6d1b71a366ae13a5fe8a3ffa65d4bdccf" }, "downloads": -1, "filename": "proteofav-0.2.0b0.tar.gz", "has_sig": false, "md5_digest": "b6b14a5b36e5138bcef9967e8546b11f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 88091, "upload_time": "2017-11-03T16:33:37", "url": "https://files.pythonhosted.org/packages/63/b9/3a8051bf28b2a0ecf14f5be9ef81850739de4d4a07b15fcdbedc5887adc9/proteofav-0.2.0b0.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "5070c06aa8cf007eb2b6a4e871ac013e", "sha256": "c2b2f64d9732f6de7b3511c55d3d8fa96e7539d1aa92ebd348d44b48ef30ac50" }, "downloads": -1, "filename": "proteofav-0.2.2.tar.gz", "has_sig": false, "md5_digest": "5070c06aa8cf007eb2b6a4e871ac013e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 88779, "upload_time": "2017-11-14T11:32:07", "url": "https://files.pythonhosted.org/packages/a3/65/67da2b4e8e9edce508394bd3d31789d809ea657a0abbfc1674612355bfba/proteofav-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "ae595b6fa8789b050841f93efcc2fe26", "sha256": "ed3575444c4373a7fb2892d8064413a6f411bc91d529575df786808fae48f75d" }, "downloads": -1, "filename": "proteofav-0.2.3.tar.gz", "has_sig": false, "md5_digest": "ae595b6fa8789b050841f93efcc2fe26", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 89513, "upload_time": "2017-11-28T12:44:01", "url": "https://files.pythonhosted.org/packages/e8/01/cac9ac5999f5938332a09fcf8233cf9b9be304a30bd66baf00b884c47832/proteofav-0.2.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ae595b6fa8789b050841f93efcc2fe26", "sha256": "ed3575444c4373a7fb2892d8064413a6f411bc91d529575df786808fae48f75d" }, "downloads": -1, "filename": "proteofav-0.2.3.tar.gz", "has_sig": false, "md5_digest": "ae595b6fa8789b050841f93efcc2fe26", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 89513, "upload_time": "2017-11-28T12:44:01", "url": "https://files.pythonhosted.org/packages/e8/01/cac9ac5999f5938332a09fcf8233cf9b9be304a30bd66baf00b884c47832/proteofav-0.2.3.tar.gz" } ] }