swancontents

Name	swancontents JSON
Version	2.1.11 JSON
	download
home_page	https://github.com/swan-cern/jupyter-extensions
Summary	SWAN Contents Manager for Jupyter
upload_time	2024-09-13 15:59:25
maintainer	None
docs_url	None
author	SWAN Admins
requires_python	>=3.9
license	AGPL-3.0
keywords	jupyter notebooks swan cern
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "Jupyter, Notebooks, SWAN, CERN",
    "author": "SWAN Admins",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/d8/6d/c934c1c8e926541139c07a5b63de6cdfcbef7ad8f5fe8ee6dba69df1c82a/swancontents-2.1.11.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.11",
    "project_urls": {
        "Homepage": "https://github.com/swan-cern/jupyter-extensions"
    },
    "split_keywords": [
        "jupyter",
        " notebooks",
        " swan",
        " cern"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9d92a82a7a83dd9216daec24a48a3512bc107eded9bf4181b6ed27152c6cd0a3",
                "md5": "573db5b83b24ba21fd0870639089234e",
                "sha256": "123dfcf7a7aa0b6c7d20c37f61fc7c495a593d3623910b9f14efb8685418e1ed"
            },
            "downloads": -1,
            "filename": "swancontents-2.1.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "573db5b83b24ba21fd0870639089234e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 126739,
            "upload_time": "2024-09-13T15:59:24",
            "upload_time_iso_8601": "2024-09-13T15:59:24.091838Z",
            "url": "https://files.pythonhosted.org/packages/9d/92/a82a7a83dd9216daec24a48a3512bc107eded9bf4181b6ed27152c6cd0a3/swancontents-2.1.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d86dc934c1c8e926541139c07a5b63de6cdfcbef7ad8f5fe8ee6dba69df1c82a",
                "md5": "3cdec391ad4af2fae4662487fc234266",
                "sha256": "29e4cda10529157f875e6766cda712636db73162b2832dd141a074d50cb24cae"
            },
            "downloads": -1,
            "filename": "swancontents-2.1.11.tar.gz",
            "has_sig": false,
            "md5_digest": "3cdec391ad4af2fae4662487fc234266",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 93034,
            "upload_time": "2024-09-13T15:59:25",
            "upload_time_iso_8601": "2024-09-13T15:59:25.610680Z",
            "url": "https://files.pythonhosted.org/packages/d8/6d/c934c1c8e926541139c07a5b63de6cdfcbef7ad8f5fe8ee6dba69df1c82a/swancontents-2.1.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-13 15:59:25",
    "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"
}