Syncano references

Subpackages

• syncano.models
  • Submodules
    • syncano.models.manager
    • syncano.models.accounts
    • syncano.models.archetypes
    • syncano.models.billing
    • syncano.models.channels
    • syncano.models.classes
    • syncano.models.custom_response
    • syncano.models.data_views
    • syncano.models.incentives
    • syncano.models.instances
    • syncano.models.fields
    • syncano.models.options
    • syncano.models.push_notification
    • syncano.models.registry
    • syncano.models.traces
  • Module contents

Submodules

• syncano.connection
• syncano.exceptions
• syncano.utils module

Module contents

connect(*args, **kwargs)

Connects to Syncano API.

Parameters:

• email (string) – Your Syncano account email address
• password (string) – Your Syncano password
• api_key (string) – Your Syncano account key or instance api_key
• username (string) – Instance user name
• user_key (string) – Instance user key
• instance_name (string) – Your Syncano instance_name
• verify_ssl (boolean) – Verify SSL certificate

Return type:

syncano.models.registry.Registry

Returns:

A models registry

Usage:

# Admin login
connection = syncano.connect(email='', password='')
# OR
connection = syncano.connect(api_key='')
# OR
connection = syncano.connect(social_backend='github', token='sfdsdfsdf')

# User login
connection = syncano.connect(username='', password='', api_key='', instance_name='')
# OR
connection = syncano.connect(user_key='', api_key='', instance_name='')