Craedl Python SDK Documentation

Introduction

The Craedl Python SDK (Software Development Kit) enables Craedl.org users to access their Craedl accounts using the Python programming language. This provides a mechanism for using Craedl on computers without access to a web browser (such as a high-performance computing cluster) and to automate common Craedl project manipulations (such as file uploads and downloads) within a Python script.

Quick start

Get started with the Craedl Python SDK by obtaining it via PyPI:

pip install craedl

Log into your Craedl account at Craedl.org and generate an API access token by clicking the key in your profile view. Copy your token and paste it when prompted after running one of the following commands:

(A) Configure your account through a system shell

python -m craedl

(B) Configure your account through an interactive Python interpreter

import craedl
craedl.configure()

Now you can use Python to access your Craedl, for example:

import craedl
profile = craedl.auth()
for craedl in profile.craedls:
    print(craedl)

Documentation

• The basics
  • Obtain the Craedl Python SDK module
  • Configure your authentication token
  • Use the Craedl Python SDK
• Examples
  • See Craedls
  • Download data
  • Upload data
  • Upload directory recursively
• Craedl Python SDK documentation
  • Core
    • Auth
    • Craedl
    • Inode
    • Profile
  • Cache
    • Cache