Make an API request

Find a role by name. Returns None if not found.

Add a user to the UserDict

Join components of url into a relative url. Use to prevent double slash when joining subpath. This will leave the initial and final / in plac

Retrieve a User object if it can be found, else default Lookup can be by User object, id, or name .. versionchanged:: 1.2

Login a user by name, returning her cookies.

Add a user to the database.

Return the full, public base URL (including prefix) of the given JupyterHub instance.

Create a new API token If `token` is given, load that token.

Generate a temporary user with specific scopes. Convenience function that provides setup, database handling and teardown

Authenticate the user who is attempting to log in Returns user dict if successful, None otherwise. This calls `authenticate`, which

Return the public *host* (no URL prefix) of the given JupyterHub instance.

Return an asyncio Future Use instead of gen.maybe_future For our compatibility, this must accept: - asyncio coroutine (gen.maybe_future

Return header with user's API authorization token.

Load default and user-defined roles and scopes into the database

Remove and return an item

Ensure we start with a clean user & role list

Delete a user from the cache and the database

Roll back any uncommitted transactions from the handler.

Start the user's spawner depending from the value of JupyterHub.allow_named_servers if False: JupyterHub expects only one si

Get a user by name return None if no such user

Add a user's server to the proxy table.

Find user in database.

Retrieve and decrypt auth_state for the user

Grant shared permissions for a server Updates existing Share if there is one, otherwise creates a new Share

Is this my token?

Find scopes for a given user or token from their roles and resolve permissions Arguments: orm_object: orm object or User wrapper Retur

POST spawns with user-specified options

Count the number of user servers that are active/pending/ready Returns dict with counts of active/pending/ready servers

Render a datetime object as an ISO 8601 UTC timestamp Naive datetime objects are assumed to be UTC

Return a new unique username

Return the body of the request as JSON data.

Store an entry in the cache Purges oldest entry if cache is full

Make an authenticated API request of the proxy.

Fetch and return all the routes associated by JupyterHub from the proxy. **Subclasses must define this method** Should retur

Load users into and from the database

Escape a value to be used in URLs, cookies, etc.

Render jinja2 template If sync is set to True, we render the template & return a string If sync is set to False, we return a

Validate a normalized username Return True if username is valid, False otherwise.

Check if a username is allowed to authenticate based on configuration Return True if username is allowed, False otherwise. No allowe

Generate a temporary role with certain scopes. Convenience function that provides setup, database handling and teardown

Is the current request being made with the given scope?

filling the login form by user and pass_w parameters and initiate the login

dict-like get

I can't seem to avoid typing self.log

Generate a new API token for a user or service

Purge all expired values

GET /api/ returns info about the Hub and its API. It is not an authenticated endpoint For now, it just returns the version of Jupyter

Check if the single-user process is running Returns: None if single-user process is running. Integer exit status (0 if un

Get the url for a server with a given name

Parses scopes and filters in something akin to JSON style For instance, scope list ["users", "groups!group=foo", "servers!server=user/bar",

Get a single random port.

Encrypt and store auth_state

Lookup orm.Spawner for user_name/server_name raise 404 if not found

Assert that an item with a given id is not found

Get the next_url for login redirect Default URL after login: - if redirect_to_server (default): send to user's own server -

shorthand for mtime

Normalize the given username and return it Override in subclasses if usernames need different normalization rules. The default attem

Return utcnow with_tz (default): returns tz-aware datetime in UTC if with_tz=False, returns UTC timestamp without tzinfo (used for most

Cast an environment variable to bool If unset or empty, return `default` `0` is False; all other values are True.

Apply group overrides before starting a server

Check that all users are properly routed on the proxy.

Returns a set of fully expanded scopes for a collection of raw scopes Arguments: scopes (collection(str)): collection of raw scopes o

Load predefined groups into the database

Fixture to launch a new hub for testing

Wait for this server to come up

Filter out any entries in a path list that are in my home directory. Used to disable per-user configuration.

Assigns default role(s) to an entity: tokens get 'token' role users and services get 'admin' role if they are admin (removed if they are not

Remove a user's server from the proxy table.

Exponentially backoff until `pass_func` is true. The `pass_func` function will wait with **exponential backoff** and **random jitter** f

Fill a default user model Any unspecified fields will be filled with the defaults

Find and return a group by name. Raise 404 if not found.