Welcome to bass’s documentation!¶
Bass is the identity library of the Open Permissions Platform. This is the documentation of the Python API intended for developers. To have more information on usage please refer to the documentation in our repository http://github.com/openpermissions/bass .
Bass is the identity library of the Open Permissions Platform. This is the documentation of the Python API intended for developers. To have more information on usage please refer to the documentation in our repository http://github.com/openpermissions/bass .
Bass is the identity library of the Open Permissions Platform. This is the documentation of the Python API intended for developers. To have more information on usage please refer to the documentation in our repository http://github.com/openpermissions/bass .
Contents:
bass package¶
Submodules¶
bass.hubkey module¶
Generate hub keys
The generated hub key will be of the format
<resolver_id>/<schema_version>/<hub_id>/<repository_id>/<entity_type>/<entity_id>
- bass.hubkey.generate_hub_key(resolver_id, hub_id, repository_id, entity_type, entity_id=None)[source]¶
Create and return an array of hub keys :param resolver_id: the service that can resolve this key :param hub_id: the unique id of the hub :param repository_id: the type of id that the provider recognises :param entity_type: the type of the entity to which the key refers. :param entity_id: ID of entity (UUID) :returns: a hub key :raises: :AttributeError: if a parameter has a bad value :TypeError: if a parameter has a bad value :ValueError: if a parameter has a bad value
- bass.hubkey.idna_encode(string)[source]¶
Encode a string as ASCII using IDNA so that it is a valid part of a URI
See RFC3490.
Parameters: string – str Returns: ASCII string
- bass.hubkey.is_hub_key(value)[source]¶
Test if a value could be a hub key :param value: the value to test if it is a hub key :returns: True if it is a hub key
- bass.hubkey.match_part(string, part)[source]¶
Raise an exception if string doesn’t match a part’s regex
Parameters: - string – str
- part – a key in the PARTS dict
Raises: ValueError, TypeError