{ "info": { "author": "", "author_email": "", "bugtrack_url": null, "classifiers": [], "description": "# sandstone-spawner\nJupyterHub Spawner class for starting Sandstone HPC user instances\n\n## Installation\n**This module requires the JupyterHub Login Handler for Sandstone, found at https://github.com/SandstoneHPC/sandstone-jupyterhub-login**\n\nInstall the module with\n```\npython setup.py install\n```\n\nSet the `SANDSTONE_SETTINGS` environment variable to the absolute path of your Sandstone settings file, and then set the `SANDSTONE_APP_PATH` environment variable to the absolute path of the `sandstone-jupyterhub` executable. This executable is provided by `sandstone-jupyterhub-login`.\n```\nexport SANDSTONE_APP_PATH=/path/to/sandstone-jupyterhub\n```\n\n## JupyterHub Config\nModify your JupyterHub config file to set the default spawner as `SandstoneSpawner`.\n```python\nc.JupyterHub.spawner_class = 'sandstone_spawner.spawner.SandstoneSpawner'\n```\n\n### Spawn Jupyter Notebooks and Sandstone\nIf you would like JupyterHub to be able to spawn Sandstone as well as Jupyter Notebooks, configure the _ProfilesSpawner_ to wrap the _SandstoneSpawner_:\n```python\nc.JupyterHub.spawner_class = 'wrapspawner.ProfilesSpawner'\nc.Spawner.http_timeout = 120\n\nc.ProfilesSpawner.profiles = [( \"Host process\",\n 'local','jupyterhub.spawner.LocalProcessSpawner', {'ip':'0.0.0.0'} ),\n ('Sandstone', 'sandstone','sandstone_spawner.spawner.SandstoneSpawner', {}),\n]\n```\n\n## Running the Docker Image\nThe Docker image included in this repo provides an example setup of a JupyterHub instance that can spawn either a Jupyter Notebook or Sandstone instance. The image has two example users _(username:password)_:\n* sandstone1:sandstone1\n* sandstone2:sandstone2\n\nTo build and run this image:\n```\ndocker build -t sandstone-jupyterhub .\ndocker run -p 8000:8000 -d sandstone-jupyterhub\n```\n\nJupyterHub will be accessible on http://localhost:8000/.\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "sandstone-spawner", "package_url": "https://pypi.org/project/sandstone-spawner/", "platform": null, "project_url": "https://pypi.org/project/sandstone-spawner/", "project_urls": null, "release_url": "https://pypi.org/project/sandstone-spawner/0.1.1/", "requires_dist": null, "requires_python": "", "summary": "Sandstone JupyterHub Spawner", "version": "0.1.1" }, "last_serial": 2862128, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "305e70d1eb8c5ddeabae0225e2b21b16", "sha256": "55a6a22dad0651b1bd725e0929d1896ce2ec7d093c002059a61a6638ff7da8a2" }, "downloads": -1, "filename": "sandstone-spawner-0.1.0.tar.gz", "has_sig": false, "md5_digest": "305e70d1eb8c5ddeabae0225e2b21b16", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2093, "upload_time": "2017-05-05T17:08:18", "url": "https://files.pythonhosted.org/packages/84/ff/cd5f62d8b913b1eb9d365b0fba67231946b6f3d87f6ea2c494475599c5ef/sandstone-spawner-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "72439e648806e8b85e226a03219ade1e", "sha256": "ae4f9181a3599bb0341bc7d7f982b6f75cd9118f3664e3323566ea2b329acade" }, "downloads": -1, "filename": "sandstone-spawner-0.1.1.tar.gz", "has_sig": false, "md5_digest": "72439e648806e8b85e226a03219ade1e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3559, "upload_time": "2017-05-09T16:41:32", "url": "https://files.pythonhosted.org/packages/35/2c/30a94aaec38295ebd5d6bad53ce72ecc7e4c5e03f7a95de3870d36b83c00/sandstone-spawner-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "72439e648806e8b85e226a03219ade1e", "sha256": "ae4f9181a3599bb0341bc7d7f982b6f75cd9118f3664e3323566ea2b329acade" }, "downloads": -1, "filename": "sandstone-spawner-0.1.1.tar.gz", "has_sig": false, "md5_digest": "72439e648806e8b85e226a03219ade1e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3559, "upload_time": "2017-05-09T16:41:32", "url": "https://files.pythonhosted.org/packages/35/2c/30a94aaec38295ebd5d6bad53ce72ecc7e4c5e03f7a95de3870d36b83c00/sandstone-spawner-0.1.1.tar.gz" } ] }