The SpaceGDN class

class pyspacegdn.SpaceGDN(client_name='Uknown', client_version='uknown', endpoint='gdn.jamy.be')

The main class for pySpaceGDN.

An instance of this class is the entrypoint for pySpaceGDN. Through this class, most request types defined by SpaceGDN can be sent to a SpaceGDN host.

Methods:

find()

Create a find request

usage()

Create an usage request

Attributes:

client_name

The name of the client that created this instance. If the client name is not set, this will be Uknown

client_version

The version of the client that created this instance. If the client version is not set, this will be uknown

endpoint

The endpoint this instance relates to.

user_agent

The user agent string for this client.

__init__(client_name='Uknown', client_version='uknown', endpoint='gdn.jamy.be')

Instantiate a new SpaceGDN client.

There are no required arguments. The client name and version arguments are used to set the user agents, and should be set when using pySpaceGDN for other things than testing.

Optional arguments:

client_name (str)

The name of the client using this instance. Defaults to Uknown.

client_version (str)

The version of the client using this instance. Defaults to uknown.

endpoint (str)

The endpoint to connect to. Defaults to pyspacegdn.DEFAULT_ENDPOINT in pyspacegdn.

find()

Create and return a new pyspacegdn.requests.FindRequest.

usage()

Create and return a new pyspacegdn.requests.UsageRequest.