`plynx.web.common`¶

Common utils of the web service.

Module Contents¶

plynx.web.common.app[source]¶

plynx.web.common.logger[source]¶

plynx.web.common.DEFAULT_EMAIL =[source]¶

plynx.web.common.DEFAULT_USERNAME = default[source]¶

plynx.web.common.DEFAULT_PASSWORD =[source]¶

plynx.web.common._CONFIG[source]¶

plynx.web.common.register_user(username: str, password: str, email: str, picture: str = '', is_oauth: bool = False, display_name: Optional[str] = None) → User[source]¶: Register a new user.

plynx.web.common._init_default_user()[source]¶

plynx.web.common.verify_password(username_or_token: str, password: str)[source]¶: Veryfy password based on user

plynx.web.common.authenticate()[source]¶: Return 401 message

plynx.web.common.requires_auth(f)[source]¶: Auth wrapper

plynx.web.common.make_fail_response(message, **kwargs)[source]¶: Return basic fail response

plynx.web.common.make_permission_denied(message: str = 'Permission denied')[source]¶: Return permission error

plynx.web.common.make_success_response(extra_response: Optional[Dict[str, Any]] = None)[source]¶: Return successful response

plynx.web.common.handle_errors(f)[source]¶: Handle errors wrapper

plynx.web.common.run_api(verbose)[source]¶: Run web service