# SwanCuller
JupyterHub service that checks and cleans user sessions.
It also calls bash scripts to check/renew kerberos tokens for the users, if their sessions still exist, or remove them if not in use.
## Requirements
This module requires and installs Tornado.
## Installation
Install the package:
```bash
pip install swanculler
```
## Usage
Call the binary and specify configuration parameters:
```bash
swanculler --cull_every=600
```
Configuration parameters:
* url: The JupyterHub API URL (default=$JUPYTERHUB_API_URL)
* timeout: The idle timeout (in seconds) (default=600)
* cull_every: The interval (in seconds) for checking for idle servers to cull (default=0)
* max_age: The maximum age (in seconds) of servers that should be culled even if they are active (default=0)
* cull_users: Cull users in addition to servers (default=False)
* concurrency: Limit the number of concurrent requests made to the Hub (default=10)
* hooks_dir: Path to the directory for the krb tickets script (check_ticket.sh) (default="/srv/jupyterhub/culler)
* disable_hooks: Whether to call the krb tickets scripts or not (default=False)
Raw data
{
"_id": null,
"home_page": "https://github.com/swan-cern/jupyterhub-extensions",
"name": "swanculler",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "JupyterHub,SWAN,CERN",
"author": "SWAN Admins",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/45/b1/db9614f2aca71bc02112d355d6cb6442911eeebe16db259f739969af30e6/swanculler-1.0.0.tar.gz",
"platform": "Linux",
"description": "# SwanCuller\n\nJupyterHub service that checks and cleans user sessions.\nIt also calls bash scripts to check/renew kerberos tokens for the users, if their sessions still exist, or remove them if not in use.\n\n## Requirements\n\nThis module requires and installs Tornado.\n\n## Installation\n\nInstall the package:\n\n```bash\npip install swanculler\n```\n\n## Usage\n\nCall the binary and specify configuration parameters:\n```bash\nswanculler --cull_every=600\n```\n\nConfiguration parameters:\n* url: The JupyterHub API URL (default=$JUPYTERHUB_API_URL)\n* timeout: The idle timeout (in seconds) (default=600)\n* cull_every: The interval (in seconds) for checking for idle servers to cull (default=0)\n* max_age: The maximum age (in seconds) of servers that should be culled even if they are active (default=0)\n* cull_users: Cull users in addition to servers (default=False)\n* concurrency: Limit the number of concurrent requests made to the Hub (default=10)\n* hooks_dir: Path to the directory for the krb tickets script (check_ticket.sh) (default=\"/srv/jupyterhub/culler)\n* disable_hooks: Whether to call the krb tickets scripts or not (default=False)\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Culler for JupyterHub",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/swan-cern/jupyterhub-extensions"
},
"split_keywords": [
"jupyterhub",
"swan",
"cern"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78d3a8bf00c7d85f358be7556d00288cb19c987e905a64e3eb79cb4109652bdb",
"md5": "e8f146216497c2552fd169d33a60b50e",
"sha256": "7553c39c4b58d9e5cdd7ac3d5d24b59b75e406992b80cbe1de2a8e36db57a97b"
},
"downloads": -1,
"filename": "swanculler-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8f146216497c2552fd169d33a60b50e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7268,
"upload_time": "2023-10-24T13:00:20",
"upload_time_iso_8601": "2023-10-24T13:00:20.537925Z",
"url": "https://files.pythonhosted.org/packages/78/d3/a8bf00c7d85f358be7556d00288cb19c987e905a64e3eb79cb4109652bdb/swanculler-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "45b1db9614f2aca71bc02112d355d6cb6442911eeebe16db259f739969af30e6",
"md5": "5546712335a408cfb820ec4b19d9b37b",
"sha256": "06eeba584262b8c33f927a7ff11a26ee187bde08fac6e1d25d96690d0054fcbc"
},
"downloads": -1,
"filename": "swanculler-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "5546712335a408cfb820ec4b19d9b37b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7281,
"upload_time": "2023-10-24T13:00:22",
"upload_time_iso_8601": "2023-10-24T13:00:22.114936Z",
"url": "https://files.pythonhosted.org/packages/45/b1/db9614f2aca71bc02112d355d6cb6442911eeebe16db259f739969af30e6/swanculler-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-24 13:00:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "swan-cern",
"github_project": "jupyterhub-extensions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "swanculler"
}
JSON
