ohnope.plugins package#

Subpackages#

Module contents#

Functions and routines associated with rawberth Oh-nope IRC Services.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class ohnope.plugins.ChanServ(robie: Robie, name: str, params: RobieChildParams)#

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

operate() → None#

Perform the operation related to Homie service threads.

property params: ChanServParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None#

Perform advanced validation on the parameters provided.

class ohnope.plugins.ChanServParams(_parse: ~typing.Callable[[...], ~typing.Any] | None = None, *, enable: bool = True, locate: ~typing.Annotated[str | None, ~annotated_types.MinLen(min_length=1)] = None, trusted: ~typing.Annotated[list[str] | None, ~annotated_types.MinLen(min_length=1)] = None, nickname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'ChanServ', realname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'Channel registration', unique: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'CHANS0', status: ~enrobie.plugins.status.params.StatusPluginIconParams = <factory>)#

Bases: RobiePluginParams

Process and validate the core configuration parameters.

enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')]#
model_config = {'extra': 'forbid'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nickname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='ChanServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])]#
realname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Channel registration', description='What realname for the service', metadata=[MinLen(min_length=1)])]#
status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#
unique: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='CHANS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])]#
class ohnope.plugins.ChatServ(robie: Robie, name: str, params: RobieChildParams)#

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

operate() → None#

Perform the operation related to Homie service threads.

property params: ChatServParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None#

Perform advanced validation on the parameters provided.

class ohnope.plugins.ChatServParams(_parse: ~typing.Callable[[...], ~typing.Any] | None = None, *, enable: bool = True, locate: ~typing.Annotated[str | None, ~annotated_types.MinLen(min_length=1)] = None, trusted: ~typing.Annotated[list[str] | None, ~annotated_types.MinLen(min_length=1)] = None, nickname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'ChatServ', realname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'Invitable LLM chatting', unique: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'CHATS0', status: ~enrobie.plugins.status.params.StatusPluginIconParams = <factory>)#

Bases: RobiePluginParams

Process and validate the core configuration parameters.

enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')]#
model_config = {'extra': 'forbid'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nickname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='ChatServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])]#
realname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Invitable LLM chatting', description='What realname for the service', metadata=[MinLen(min_length=1)])]#
status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#
unique: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='CHATS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])]#
class ohnope.plugins.HelpServ(robie: Robie, name: str, params: RobieChildParams)#

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

operate() → None#

Perform the operation related to Homie service threads.

property params: HelpServParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None#

Perform advanced validation on the parameters provided.

class ohnope.plugins.HelpServParams(_parse: ~typing.Callable[[...], ~typing.Any] | None = None, *, enable: bool = True, locate: ~typing.Annotated[str | None, ~annotated_types.MinLen(min_length=1)] = None, trusted: ~typing.Annotated[list[str] | None, ~annotated_types.MinLen(min_length=1)] = None, nickname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'HelpServ', realname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'Help about the services', unique: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'HELPS0', status: ~enrobie.plugins.status.params.StatusPluginIconParams = <factory>)#

Bases: RobiePluginParams

Process and validate the core configuration parameters.

enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')]#
model_config = {'extra': 'forbid'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nickname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='HelpServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])]#
realname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Help about the services', description='What realname for the service', metadata=[MinLen(min_length=1)])]#
status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#
unique: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='HELPS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])]#
class ohnope.plugins.HostServ(robie: Robie, name: str, params: RobieChildParams)#

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

operate() → None#

Perform the operation related to Homie service threads.

property params: HostServParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None#

Perform advanced validation on the parameters provided.

class ohnope.plugins.HostServParams(_parse: ~typing.Callable[[...], ~typing.Any] | None = None, *, enable: bool = True, locate: ~typing.Annotated[str | None, ~annotated_types.MinLen(min_length=1)] = None, trusted: ~typing.Annotated[list[str] | None, ~annotated_types.MinLen(min_length=1)] = None, nickname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'HostServ', realname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'Host cloak management', unique: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'HOSTS0', status: ~enrobie.plugins.status.params.StatusPluginIconParams = <factory>)#

Bases: RobiePluginParams

Process and validate the core configuration parameters.

enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')]#
model_config = {'extra': 'forbid'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nickname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='HostServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])]#
realname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Host cloak management', description='What realname for the service', metadata=[MinLen(min_length=1)])]#
status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#
unique: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='HOSTS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])]#
class ohnope.plugins.MemoServ(robie: Robie, name: str, params: RobieChildParams)#

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

operate() → None#

Perform the operation related to Homie service threads.

property params: MemoServParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None#

Perform advanced validation on the parameters provided.

class ohnope.plugins.MemoServParams(_parse: ~typing.Callable[[...], ~typing.Any] | None = None, *, enable: bool = True, locate: ~typing.Annotated[str | None, ~annotated_types.MinLen(min_length=1)] = None, trusted: ~typing.Annotated[list[str] | None, ~annotated_types.MinLen(min_length=1)] = None, nickname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'MemoServ', realname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'Offline message sharing', unique: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'MEMOS0', status: ~enrobie.plugins.status.params.StatusPluginIconParams = <factory>)#

Bases: RobiePluginParams

Process and validate the core configuration parameters.

enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')]#
model_config = {'extra': 'forbid'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nickname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='MemoServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])]#
realname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Offline message sharing', description='What realname for the service', metadata=[MinLen(min_length=1)])]#
status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#
unique: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='MEMOS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])]#
class ohnope.plugins.NickServ(robie: Robie, name: str, params: RobieChildParams)#

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

operate() → None#

Perform the operation related to Homie service threads.

property params: NickServParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None#

Perform advanced validation on the parameters provided.

class ohnope.plugins.NickServParams(_parse: ~typing.Callable[[...], ~typing.Any] | None = None, *, enable: bool = True, locate: ~typing.Annotated[str | None, ~annotated_types.MinLen(min_length=1)] = None, trusted: ~typing.Annotated[list[str] | None, ~annotated_types.MinLen(min_length=1)] = None, nickname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'NickServ', realname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'Nickname registration', unique: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'NICKS0', status: ~enrobie.plugins.status.params.StatusPluginIconParams = <factory>)#

Bases: RobiePluginParams

Process and validate the core configuration parameters.

enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')]#
model_config = {'extra': 'forbid'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nickname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='NickServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])]#
realname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Nickname registration', description='What realname for the service', metadata=[MinLen(min_length=1)])]#
status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#
unique: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='NICKS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])]#
class ohnope.plugins.OperServ(robie: Robie, name: str, params: RobieChildParams)#

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

operate() → None#

Perform the operation related to Homie service threads.

property params: OperServParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None#

Perform advanced validation on the parameters provided.

class ohnope.plugins.OperServParams(_parse: ~typing.Callable[[...], ~typing.Any] | None = None, *, enable: bool = True, locate: ~typing.Annotated[str | None, ~annotated_types.MinLen(min_length=1)] = None, trusted: ~typing.Annotated[list[str] | None, ~annotated_types.MinLen(min_length=1)] = None, nickname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'OperServ', realname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'Network administration', unique: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'OPERS0', status: ~enrobie.plugins.status.params.StatusPluginIconParams = <factory>)#

Bases: RobiePluginParams

Process and validate the core configuration parameters.

enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')]#
model_config = {'extra': 'forbid'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nickname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='OperServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])]#
realname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Network administration', description='What realname for the service', metadata=[MinLen(min_length=1)])]#
status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#
unique: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='OPERS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])]#
class ohnope.plugins.RootServ(robie: Robie, name: str, params: RobieChildParams)#

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

operate() → None#

Perform the operation related to Homie service threads.

property params: RootServParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None#

Perform advanced validation on the parameters provided.

class ohnope.plugins.RootServParams(_parse: ~typing.Callable[[...], ~typing.Any] | None = None, *, enable: bool = True, locate: ~typing.Annotated[str | None, ~annotated_types.MinLen(min_length=1)] = None, trusted: ~typing.Annotated[list[str] | None, ~annotated_types.MinLen(min_length=1)] = None, nickname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'RootServ', realname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'Network administration', unique: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'ROOTS0', status: ~enrobie.plugins.status.params.StatusPluginIconParams = <factory>)#

Bases: RobiePluginParams

Process and validate the core configuration parameters.

enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')]#
model_config = {'extra': 'forbid'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nickname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='RootServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])]#
realname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Network administration', description='What realname for the service', metadata=[MinLen(min_length=1)])]#
status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#
unique: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='ROOTS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])]#
class ohnope.plugins.StatServ(robie: Robie, name: str, params: RobieChildParams)#

Bases: RobiePlugin

Integrate with the Robie routine and perform operations.

operate() → None#

Perform the operation related to Homie service threads.

property params: StatServParams#

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None#

Perform advanced validation on the parameters provided.

class ohnope.plugins.StatServParams(_parse: ~typing.Callable[[...], ~typing.Any] | None = None, *, enable: bool = True, locate: ~typing.Annotated[str | None, ~annotated_types.MinLen(min_length=1)] = None, trusted: ~typing.Annotated[list[str] | None, ~annotated_types.MinLen(min_length=1)] = None, nickname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'StatServ', realname: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'Statistics and analysis', unique: ~typing.Annotated[str, ~annotated_types.MinLen(min_length=1)] = 'STATS0', status: ~enrobie.plugins.status.params.StatusPluginIconParams = <factory>)#

Bases: RobiePluginParams

Process and validate the core configuration parameters.

enable: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=True, description='Determine if service enabled')]#
model_config = {'extra': 'forbid'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nickname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='StatServ', description='What nickname for the service', metadata=[MinLen(min_length=1)])]#
realname: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='Statistics and analysis', description='What realname for the service', metadata=[MinLen(min_length=1)])]#
status: Annotated[StatusPluginIconParams, FieldInfo(annotation=NoneType, required=False, default_factory=StatusPluginIconParams, description='Icon used per chat platform')]#
unique: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='STATS0', description='Unique identifier for service', metadata=[MinLen(min_length=1)])]#
On this page

This Page