# SwanContents
Server and NB extension that provides:
* SWAN Projects (including readme preview)
* EOS integration (versioning and atomic save)
* git download
* SWAN style in a form of Jupyter Notebook templates
This module also installs a lab extension that adds links throughout the UI to switch between the Lab and the old UI.
## Requirements
Besides Jupyter, this extension requires that the user home is set inside EOS.
## Install
Install the package and the nbextension:
```bash
pip install swancontents
```
To replace the default Jupyter Contents Manager (including its Javascript library) and the templates, in the Jupyter Notebook configuration (i.e in `jupyter_notebook_config.py`), set the following:
```python
c.ServerApp.contents_manager_class = 'swancontents.filemanager.SwanEosFileManager'
```
Note: `EOSCheckpoints` is set by default as `checkpoints_class` when using SwanEosFileManager.
Raw data
{
"_id": null,
"home_page": "https://github.com/swan-cern/jupyter-extensions",
"name": "swancontents",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "Jupyter,Notebooks,SWAN,CERN",
"author": "SWAN Admins",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/68/4c/8d299168eef153dffc1d52a13330556232095ad7fc9bc1dea934f017442d/swancontents-2.1.5.tar.gz",
"platform": "Linux",
"description": "# SwanContents\n\nServer and NB extension that provides:\n* SWAN Projects (including readme preview)\n* EOS integration (versioning and atomic save)\n* git download\n* SWAN style in a form of Jupyter Notebook templates\n\nThis module also installs a lab extension that adds links throughout the UI to switch between the Lab and the old UI.\n\n## Requirements\n\nBesides Jupyter, this extension requires that the user home is set inside EOS.\n\n## Install\n\nInstall the package and the nbextension:\n\n```bash\npip install swancontents\n```\n\nTo replace the default Jupyter Contents Manager (including its Javascript library) and the templates, in the Jupyter Notebook configuration (i.e in `jupyter_notebook_config.py`), set the following:\n\n```python\nc.ServerApp.contents_manager_class = 'swancontents.filemanager.SwanEosFileManager'\n```\n\nNote: `EOSCheckpoints` is set by default as `checkpoints_class` when using SwanEosFileManager.\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "SWAN Contents Manager for Jupyter",
"version": "2.1.5",
"project_urls": {
"Homepage": "https://github.com/swan-cern/jupyter-extensions"
},
"split_keywords": [
"jupyter",
"notebooks",
"swan",
"cern"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8311b3a4d8235e3ce2df25bdabe7822c83728b04fbf53858b1d128d5a30dcc68",
"md5": "78e2ed6b38a2d6b235a3bbfce4ba7360",
"sha256": "9c4f62f9c755db19c96567b706f6363826a1639093d6e68fe8a12a0c50a5c690"
},
"downloads": -1,
"filename": "swancontents-2.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "78e2ed6b38a2d6b235a3bbfce4ba7360",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 126131,
"upload_time": "2024-01-26T10:00:30",
"upload_time_iso_8601": "2024-01-26T10:00:30.243557Z",
"url": "https://files.pythonhosted.org/packages/83/11/b3a4d8235e3ce2df25bdabe7822c83728b04fbf53858b1d128d5a30dcc68/swancontents-2.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "684c8d299168eef153dffc1d52a13330556232095ad7fc9bc1dea934f017442d",
"md5": "75a576d844de3ee805705c00084f5425",
"sha256": "ceb8b1f419d739004300387f785e6f0226e9f5e352e70d307a8cfcb88db2c3eb"
},
"downloads": -1,
"filename": "swancontents-2.1.5.tar.gz",
"has_sig": false,
"md5_digest": "75a576d844de3ee805705c00084f5425",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 92456,
"upload_time": "2024-01-26T10:00:32",
"upload_time_iso_8601": "2024-01-26T10:00:32.100354Z",
"url": "https://files.pythonhosted.org/packages/68/4c/8d299168eef153dffc1d52a13330556232095ad7fc9bc1dea934f017442d/swancontents-2.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-26 10:00:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "swan-cern",
"github_project": "jupyter-extensions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "swancontents"
}
JSON
