Skip to main content

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:

pip install swanculler

Usage

Call the binary and specify configuration parameters:

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)

Metadata

Release files for swanculler 1.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for swanculler 1.0.6
File Size Uploaded
swanculler-1.0.6.tar.gz 7.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for swanculler 1.0.6
File Interpreter ABI Platform
swanculler-1.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 16.0 kB

Release files / swanculler-1.0.6.tar.gz

Download URL swanculler-1.0.6.tar.gz
Size 7.7 kB
Tags Source
SHA-256 checksum
How to use checksums
5159562ef6413006612cfa7cbf733627e84302c3ed4cdaecf29ff3f7019116f6
BLAKE2b-256 checksum
How to use checksums
6d501dc1744579874a14fc06c690c0b2fe79ad07b2c7dc8a2496419d7008a460
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

Release files / swanculler-1.0.6-py3-none-any.whl

Download URL swanculler-1.0.6-py3-none-any.whl
Size 8.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cb574ebd1c868aacf4f3812ac78b27a2c5d3e93f631e9e4eb52637c24bff6dbc
BLAKE2b-256 checksum
How to use checksums
36ddc202b9d62b6f4d3c62c0ead9b1334d5269219cbb51103d6767a2bbfc9956
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

Release history Release notifications | RSS feed

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

This release

1.0.6 This release

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page