# Nanome
This library allows users to create Python plugins for Nanome VR Molecular Design Software (https://nanome.ai/)
![gif-1](https://media.giphy.com/media/RfZhOVwyp4GS8tBbNr/giphy-downsized.gif)
### Examples
Check out our other repositories to see plugin examples ([docking](https://github.com/nanome-ai/plugin-docking), for instance)
### Installation
In order to use Nanome Plugin API, you need Python 3.5+ or 2.7+
To install the library, run:
```sh
$ pip install nanome
```
As of version 0.38.0, we provide schemas for serializing nanome API objects in JSON. To use these, install with:
```sh
$ pip install nanome[schemas]
```
Some modules in the `beta` folder require extra dependencies. To install these, run:
```sh
$ pip install nanome[beta]
```
### Documentation
All documentation needed to use this package is available at [Read The Docs](https://nanome.readthedocs.io/en/latest/)
#### Building Docs
```sh
pip install sphinx sphinx_rtd_theme
cd doc
make html
# start server to serve html docs
cd build/html
python -m http.server 8000
```
### License
MIT
Raw data
{
"_id": null,
"home_page": "https://github.com/nanome-ai/nanome",
"name": "nanome",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "virtual-reality,chemistry,python,api,plugin",
"author": "Nanome",
"author_email": "hello@nanome.ai",
"download_url": "https://files.pythonhosted.org/packages/4d/ff/59cbc8dbd5930947f0bc1f7c2f53a70b56fd9dd307f91fbd75dc88cde7b5/nanome-0.42.0.tar.gz",
"platform": "any",
"description": "# Nanome\n\nThis library allows users to create Python plugins for Nanome VR Molecular Design Software (https://nanome.ai/)\n\n![gif-1](https://media.giphy.com/media/RfZhOVwyp4GS8tBbNr/giphy-downsized.gif)\n\n\n### Examples\n\nCheck out our other repositories to see plugin examples ([docking](https://github.com/nanome-ai/plugin-docking), for instance)\n\n### Installation\n\nIn order to use Nanome Plugin API, you need Python 3.5+ or 2.7+\nTo install the library, run:\n\n```sh\n$ pip install nanome\n```\n\nAs of version 0.38.0, we provide schemas for serializing nanome API objects in JSON. To use these, install with:\n```sh\n$ pip install nanome[schemas]\n```\n\nSome modules in the `beta` folder require extra dependencies. To install these, run:\n```sh\n$ pip install nanome[beta]\n```\n\n### Documentation\n\nAll documentation needed to use this package is available at [Read The Docs](https://nanome.readthedocs.io/en/latest/)\n\n#### Building Docs\n```sh\npip install sphinx sphinx_rtd_theme\ncd doc\nmake html\n# start server to serve html docs\ncd build/html\npython -m http.server 8000\n``` \n\n\n### License\n\nMIT\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python API for Nanome Plugins",
"version": "0.42.0",
"project_urls": {
"Homepage": "https://github.com/nanome-ai/nanome"
},
"split_keywords": [
"virtual-reality",
"chemistry",
"python",
"api",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "307cc3a4cdcb966b1b25424da4a8158c151c1ab6ee844d311b45dde0c8655ec5",
"md5": "5e8d968999c292ee617dfb14515c2dbd",
"sha256": "53614d7b40b2816b040f6ed902f9c7e95e0634060263c9771cac33c072111206"
},
"downloads": -1,
"filename": "nanome-0.42.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e8d968999c292ee617dfb14515c2dbd",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 8195783,
"upload_time": "2023-11-20T15:34:59",
"upload_time_iso_8601": "2023-11-20T15:34:59.835803Z",
"url": "https://files.pythonhosted.org/packages/30/7c/c3a4cdcb966b1b25424da4a8158c151c1ab6ee844d311b45dde0c8655ec5/nanome-0.42.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4dff59cbc8dbd5930947f0bc1f7c2f53a70b56fd9dd307f91fbd75dc88cde7b5",
"md5": "b6591f337f173a15dbbfad7b27f8b721",
"sha256": "5fecde0268a2e89e32b41ee03672889d3536a62bf99661f1f7342d349b52f367"
},
"downloads": -1,
"filename": "nanome-0.42.0.tar.gz",
"has_sig": false,
"md5_digest": "b6591f337f173a15dbbfad7b27f8b721",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7914928,
"upload_time": "2023-11-20T15:35:04",
"upload_time_iso_8601": "2023-11-20T15:35:04.366611Z",
"url": "https://files.pythonhosted.org/packages/4d/ff/59cbc8dbd5930947f0bc1f7c2f53a70b56fd9dd307f91fbd75dc88cde7b5/nanome-0.42.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-20 15:35:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nanome-ai",
"github_project": "nanome",
"github_not_found": true,
"lcname": "nanome"
}