peek_plugin_base package

Subpackages

Submodules

peek_plugin_base.LoopingCallUtil module

peek_plugin_base.LoopingCallUtil.peekCatchErrbackWithLogger(logger)[source]

Peek Catch Errback With Logger

A LoopingCall will stop if any errors are thrown from the method it calls.

This decorator should ensure that no exceptions or failures are thrown into the LoopingCall, and all should continue on.

peek_plugin_base.PeekPlatformCommonHookABC module

class peek_plugin_base.PeekPlatformCommonHookABC.PeekPlatformCommonHookABC[source]

Bases: object

abstract getOtherPluginApi(pluginName: str) → Optional[object][source]

Get Other Plugin Api

Asks the plugin for it’s api object and return it to this plugin. The API returned matches the platform service.

Parameters

pluginName – The name of the plugin to retrieve the API for

Returns

An instance of the other plugins API for this Peek Platform Service.

abstract property serviceId

Service ID

Return a unique identifier for this service.

peek_plugin_base.PeekPlatformFileStorageHookABC module

class peek_plugin_base.PeekPlatformFileStorageHookABC.PeekPlatformFileStorageHookABC[source]

Bases: object

Peek Platform File Storage Hook

This ABC provides methods allowing plugins to use the file system.

Though there is nothing in place to prevent the plugins doing what ever they like, they should play nice and get their allocated path from here.

abstract property fileStorageDirectory

File Storage Directory

This method returns a Path object providing access to the managed file storage location where the plugin can persistently store any files it wants to.

See https://docs.python.org/3/library/pathlib.html#basic-use

Returns

The plugins managed storage Path object.

peek_plugin_base.PeekPlatformServerInfoHookABC module

class peek_plugin_base.PeekPlatformServerInfoHookABC.PeekPlatformServerInfoHookABC[source]

Bases: object

Peek Platform Server Info Hook

This ABC provides information for plugins that want to connect to their own code running on the server service, via the inter peek service HTTP.

abstract property peekServerHost

Peek Server Host

Returns

The IP address of the server where the peek server service is running.

abstract property peekServerHttpPort

Peek Server HTTP Port

Returns

The TCP Port of the Peek Servers HTTP Service (not the admin webapp site)

abstract property peekServerSSL

Peek server https

Returns

true or false

abstract property peekServerSSLClientBundleFilePath

PEM filepath that contains the key and the certificate of the tls client for mTLS

Returns

the PEM file path

abstract property peekServerSSLClientMutualTLSCertificateAuthorityBundleFilePath
PEM filepath that contains certificate authorities used for mTLS to

verify the identity of the peek server

Returns

the PEM file path

abstract property peekServerSSLEnableMutualTLS

Peek server https with mTLS

Returns

true or false

abstract property peekServerSSLMutualTLSTrustedPeerCertificateBundleFilePath

PEM filepath that contains trusted peer certificates

Returns

the PEM file path

peek_plugin_base.PeekVortexUtil module

peek_plugin_base.PeekVortexUtil.peekAdminName = 'peek-admin-app'

The vortex name for the Admin browser client

peek_plugin_base.PeekVortexUtil.peekAgentName = 'peek-agent-service'

The vortex name for the Agent service

peek_plugin_base.PeekVortexUtil.peekDesktopName = 'peek-office-app'

The vortex name for the Desktop browser clients

peek_plugin_base.PeekVortexUtil.peekFieldName = 'peek-field-service'

The vortex name for the Field service

peek_plugin_base.PeekVortexUtil.peekMobileName = 'peek-field-app'

The vortex name for the Mobile device/browser clients

peek_plugin_base.PeekVortexUtil.peekServerName = 'peek-logic-service'

The vortex name for the Server service

peek_plugin_base.PeekVortexUtil.peekStorageName = 'peek-storage-service'

The vortex name for the Storage service

peek_plugin_base.PeekVortexUtil.peekWorkerName = 'peek-worker-service'

The vortex name for the Worker service

peek_plugin_base.PlatformDependencyTest module

class peek_plugin_base.PlatformDependencyTest.PlatformDependencyTestCase(methodName='runTest')[source]

Bases: peek_plugin_base.PlatformDependencyTest.PlatformDependencyTestCaseBase

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

setUp()[source]

Hook method for setting up the test fixture before exercising it.

test_for_plugin_references_1()[source]
test_for_plugin_references_2()[source]
class peek_plugin_base.PlatformDependencyTest.PlatformDependencyTestCaseBase(methodName='runTest')[source]

Bases: unittest.case.TestCase

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

peek_plugin_base.PluginCommonEntryHookABC module

peek_plugin_base.PluginPackageFileConfig module