DNAnexus Python Bindings

The DNAnexus dxpy Python library provides Python bindings to interact with the DNAnexus Platform via its API. The bindings are available to Python apps running within the DNAnexus Execution Environment, and can also be used in scripts you run that access the API from the outside. Before you start digging in, you may want to take a look at the Introduction to the DNAnexus Platform. The following references may also be useful to you as you develop your own scripts and apps.

API Specification

Complete details on the API, the lifecycle of different data objects, project permissions, and more. Many methods in the bindings translate directly into API calls, so it will be helpful to have at least a general understanding of the API’s structure.

Execution Environment Reference

How applets and apps are run within the DNAnexus Platform.

Developer Portal

Links to all other docs, e.g. useful command-line tools.

Table of Contents

• 1. dxpy Package
  • 1.1. Package Configuration
• 2. dxpy.bindings Module
  • 2.1. dxpy Object Handlers
  • 2.2. Utility Functions
  • 2.3. Projects and Containers
    • 2.3.1. Accessing App-Specific Containers
  • 2.4. Records
  • 2.5. Files
    • 2.5.1. Helper Functions
    • 2.5.2. DXFile Handler
  • 2.6. Applets, Apps, Workflows, and Jobs
    • 2.6.1. DXApplet Handler
    • 2.6.2. DXApp Handler
    • 2.6.3. DXWorkflow Handler
    • 2.6.4. DXJob Handler
    • 2.6.5. DXAnalysis Handler
  • 2.7. Search
• 3. dxpy.app_builder Module
  • 3.1. App Builder Library
• 4. dxpy.utils Module
• 5. dxpy.api Module
• 6. dxpy.exceptions Module

Indices and tables

• Index
• Module Index
• Search Page