CIRpy
=====
.. image:: http://img.shields.io/pypi/v/CIRpy.svg?style=flat
:target: https://pypi.python.org/pypi/CIRpy
.. image:: http://img.shields.io/pypi/l/CIRpy.svg?style=flat
:target: https://github.com/mcs07/CIRpy/blob/master/LICENSE
.. image:: http://img.shields.io/travis/mcs07/CIRpy/master.svg?style=flat
:target: https://travis-ci.org/mcs07/CIRpy
.. image:: http://img.shields.io/coveralls/mcs07/CIRpy/master.svg?style=flat
:target: https://coveralls.io/r/mcs07/CIRpy?branch=master
Introduction
------------
**CIRpy** is a Python interface for the `Chemical Identifier Resolver (CIR)`_ by the CADD Group at the NCI/NIH.
CIR is a web service that will resolve any chemical identifier to another chemical representation. For example, you can
pass it a chemical name and and request the corresponding SMILES string::
>>> import cirpy
>>> cirpy.resolve('Aspirin', 'smiles')
'C1=CC=CC(=C1C(O)=O)OC(C)=O'
CIRpy makes interacting with CIR through Python easy. There's no need to construct url requests and parse XML responses
— CIRpy does all this for you.
Installation
------------
Install CIRpy using::
pip install cirpy
Alternatively, try one of the other `installation options`_.
Documentation
-------------
Full documentation is available at http://cirpy.readthedocs.org.
Contribute
----------
- Feature ideas and bug reports are welcome on the `Issue Tracker`_.
- Fork the `source code`_ on GitHub, make changes and file a pull request.
Acknowledgements
----------------
All of CIRpy's functionality relies on the fantastic `CIR web service`_ created by the CADD Group at the NCI/NIH.
License
-------
CIRpy is licensed under the `MIT license`_.
.. _`Chemical Identifier Resolver (CIR)`: http://cactus.nci.nih.gov/chemical/structure
.. _`installation options`: http://cirpy.readthedocs.org/en/latest/guide/install.html
.. _`CIR web service`: http://cactus.nci.nih.gov/chemical/structure
.. _`source code`: https://github.com/mcs07/CIRpy
.. _`Issue Tracker`: https://github.com/mcs07/CIRpy/issues
.. _`MIT license`: https://github.com/mcs07/CIRpy/blob/master/LICENSE
Raw data
{
"_id": null,
"home_page": "https://github.com/mcs07/CIRpy",
"name": "CIRpy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python rest api chemistry cheminformatics",
"author": "Matt Swain",
"author_email": "m.swain@me.com",
"download_url": "https://files.pythonhosted.org/packages/fc/bc/3d7cb58ba6ffcde0d18d3f0e72a22caffe7741485bd1d286fd10d6a9a397/CIRpy-1.0.2.tar.gz",
"platform": "UNKNOWN",
"description": "CIRpy\n=====\n\n.. image:: http://img.shields.io/pypi/v/CIRpy.svg?style=flat\n :target: https://pypi.python.org/pypi/CIRpy\n\n.. image:: http://img.shields.io/pypi/l/CIRpy.svg?style=flat\n :target: https://github.com/mcs07/CIRpy/blob/master/LICENSE\n\n.. image:: http://img.shields.io/travis/mcs07/CIRpy/master.svg?style=flat\n :target: https://travis-ci.org/mcs07/CIRpy\n\n.. image:: http://img.shields.io/coveralls/mcs07/CIRpy/master.svg?style=flat\n :target: https://coveralls.io/r/mcs07/CIRpy?branch=master\n\nIntroduction\n------------\n\n**CIRpy** is a Python interface for the `Chemical Identifier Resolver (CIR)`_ by the CADD Group at the NCI/NIH.\n\nCIR is a web service that will resolve any chemical identifier to another chemical representation. For example, you can\npass it a chemical name and and request the corresponding SMILES string::\n\n >>> import cirpy\n >>> cirpy.resolve('Aspirin', 'smiles')\n 'C1=CC=CC(=C1C(O)=O)OC(C)=O'\n\nCIRpy makes interacting with CIR through Python easy. There's no need to construct url requests and parse XML responses\n\u2014 CIRpy does all this for you.\n\nInstallation\n------------\n\nInstall CIRpy using::\n\n pip install cirpy\n\nAlternatively, try one of the other `installation options`_.\n\nDocumentation\n-------------\n\nFull documentation is available at http://cirpy.readthedocs.org.\n\nContribute\n----------\n\n- Feature ideas and bug reports are welcome on the `Issue Tracker`_.\n- Fork the `source code`_ on GitHub, make changes and file a pull request.\n\nAcknowledgements\n----------------\n\nAll of CIRpy's functionality relies on the fantastic `CIR web service`_ created by the CADD Group at the NCI/NIH.\n\nLicense\n-------\n\nCIRpy is licensed under the `MIT license`_.\n\n.. _`Chemical Identifier Resolver (CIR)`: http://cactus.nci.nih.gov/chemical/structure\n.. _`installation options`: http://cirpy.readthedocs.org/en/latest/guide/install.html\n.. _`CIR web service`: http://cactus.nci.nih.gov/chemical/structure\n.. _`source code`: https://github.com/mcs07/CIRpy\n.. _`Issue Tracker`: https://github.com/mcs07/CIRpy/issues\n.. _`MIT license`: https://github.com/mcs07/CIRpy/blob/master/LICENSE",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python wrapper for the NCI Chemical Identifier Resolver (CIR).",
"version": "1.0.2",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "https://github.com/mcs07/CIRpy"
},
"split_keywords": [
"python",
"rest",
"api",
"chemistry",
"cheminformatics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fcbc3d7cb58ba6ffcde0d18d3f0e72a22caffe7741485bd1d286fd10d6a9a397",
"md5": "79708fe8bd6ed980954e199d09b875bf",
"sha256": "b08c1483779e1c8fa6a5da7e383138a33e8396b31f56d827a3bca7c83e689c16"
},
"downloads": -1,
"filename": "CIRpy-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "79708fe8bd6ed980954e199d09b875bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20341,
"upload_time": "2016-01-04T23:46:47",
"upload_time_iso_8601": "2016-01-04T23:46:47.529014Z",
"url": "https://files.pythonhosted.org/packages/fc/bc/3d7cb58ba6ffcde0d18d3f0e72a22caffe7741485bd1d286fd10d6a9a397/CIRpy-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2016-01-04 23:46:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mcs07",
"github_project": "CIRpy",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "cirpy"
}
JSON
