15.1. Welcome to Sleepwalker’s documentation!

The Sleepwalker Python module simplifies interaction with a RESTful server. It is designed to abstract all HTTP specific details of interaction with a REST server. In particular, the client should not be manually constructing URIs nor defining the specific HTTP methods used to manipulate resources. The URIs and HTTP methods are instead specified in a rest-schema file.

All interaction with the server is through a DataRep object, which maps to a concrete addressable resource exposed by the server.

Contents:

• 15.1.1. Services
  • 15.1.1.1. Manual Service creation
  • 15.1.1.2. Using Managers
  • 15.1.1.3. Connection
  • 15.1.1.4. ConnectionManager
  • 15.1.1.5. Service
  • 15.1.1.6. ServiceManager
  • 15.1.1.7. class Service
  • 15.1.1.8. class ServiceManager
• 15.1.2. DataReps
  • 15.1.2.1. Using DataRep objects
  • 15.1.2.2. Links
  • 15.1.2.3. Relations
  • 15.1.2.4. Fragments
  • 15.1.2.5. class DataRep
  • 15.1.2.6. class Schema
• 15.1.3. Connections
  • 15.1.3.1. class Connection
  • 15.1.3.2. class ConnectionManager
  • 15.1.3.3. class ConnectionHook

15.1.4. Indices and tables

• Index
• Module Index

15.1.5. License

This Sleepwalker documentation is provided “AS IS” and without any warranty or indemnification. Any sample code or scripts included in the documentation are licensed under the terms and conditions of the MIT License. See the License page for more information.