Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Unofficial wrapper for the TransIP STACK API

Project description

TransIP STACK API

Build Status PyPI version codecov

Unofficial wrapper for the TransIP STACK API, written in Python 3

Installation

To install the library, simply install it using pip:

$ pip install transip-stack-api

For development installations

$ pip install -e .[dev]

Usage

To use the project, simply import the library into your project like so:

from transip_stack import Stack, StackException


with Stack(username="foo", password="bar", hostname="stack.example.com") as stack:
    try:
        url = stack.upload("local-foo.txt", remote="remote-foo.txt").share()
        print("[+] You can download remote-foo.txt at: {}".format(url))

    except StackException as e:
        print("[!] Error: {}".format(e))

The package also ships with a command line interface to easily upload files in your current working directory to stack. Configuration is done via environment variables:

$ export STACK_USERNAME=...
$ export STACK_PASSWORD=...
$ export STACK_HOSTNAME=...
$ export STACK_DIRECTORY=...

Then simply use the tool:

$ stack upload .

Note that the command line interface is a work in progress

Examples

from io import BytesIO

from transip_stack import Stack, StackException


with Stack(username="foo", password="bar", hostname="stack.example.com") as stack:
    for file in stack.files:
        print(file.name)

    for file in stack.ls("foo"):
        print(file.name)

    stack.cd("/foo")

    for file in stack.files:
        if not file.is_shared:
            file.share()

        print(file.share_url)

    user = stack.user("admin")
    user.name = "John Doe"
    user.save()

    user = stack.user_or_create_new(
        name="Someone Else", 
        username="someone", 
        password="Pa$$w0rd!", 
        disk_quota=5 * 1000 * 1000)

    print(user.is_admin)  # -> False


with Stack(username="someone", password="Pa$$w0rd!", hostname="stack.example.com") as stack:
    stack.upload("foo.txt")
    stack.download("foo.txt", "example.txt")

    buff = BytesIO()
    stack.download_into("foo.txt", buffer=buff)
    print(buff.getvalue().decode())

    try:
        user = stack.user('admin')
    except StackException as e:
        print(e)  # -> "Access denied .."

Without context managers:

from transip_stack import Stack


stack = Stack(username="foo", password="bar", hostname="stack.example.com")
stack.login()

stack.cd("/foo")

for file in stack.files:
    file.unshare()

stack.logout()  # Important

API endpoints

Logging in

  • POST /login
    • Query
      • None
    • Body
      • username: str
      • password: str
    • Response
      • Success: HTTP 302
      • Failure: HTTP 200

Logging out

  • GET /logout
    • Query
      • None
    • Body
      • None
    • Response
      • Success: HTTP 302
      • Failure: N/A

Listing files

  • GET /api/files
    • Query
      • dir: str = "/"
      • type: str = "files"
      • public: bool = false
      • offset: int = 0
      • limit: int = 1
      • sortBy: str = "default"
      • order: str = "asc"
      • query: str = ""
    • Body
      • None

Sharing a file

  • POST /api/files/update
    • Headers
      • CSRF-Token
    • Query
      • None
    • Body (JSON)
      • Array of:
        • action: str = "share"
        • path: str = "<full path to file, see node.path>"
        • active: bool = true
          • true: File will be shared and get assigned a token
          • false: File will no longer be shared
        • allowWrites: bool = false
        • updatePassword: bool = true
          • Set to true if you want to set a password
        • sharePassword: str = "<your share password>"
          • Required when setting a password
        • updateExpireDate: bool = true
          • *Set to true if you want to set an expiry date
        • expireDate: date = "<your share expiry date>"
          • Required when setting an expiry date

Deleting a file

  • POST /api/files/update
  • Headers
    • CSRF-Token
  • Query
    • None
  • Body (JSON)
    • Array of:
      • action: str = "delete"
      • path: str = "<full path to file, see node.path>"
      • query: str = ""
        • Not sure why this is added, possibly for mass file deletion

Getting file information

  • GET /api/pathinfo
    • Query
      • path: str = "<full path to file>"
    • Body
      • None

Marking a file as favorited

  • POST /api/files/update
  • Headers
    • CSRF-Token
  • Query
    • None
  • Body (JSON)
    • Array of:
      • action: str = "favorite"
      • active: bool
        • True = Favorited
        • False = Unfavorited
      • path: str = "<full path to file, see node.path>"
      • query: str = ""
        • Not sure why this is added, possibly for mass file deletion

List users

  • GET /api/users
    • Body
      • None
    • Query
      • public: bool = false
      • offset: int = 0
      • limit: int = 50
      • query str = ""

Delete a user

  • POST /api/users/update
    • Body (JSON)
      • Array of:
        • action: str = "delete"
        • user: User
          • *The entire user object you got from GET /api/users
    • Query
      • None

Update a user's properties

  • POST /api/users/update
    • Body (JSON)
      • Array of:
        • action: str = "update"
        • user: User
    • Query
      • None

Headers

  • CSRF-Token
    • Found in /files in a meta tag with the name csrf-token

Types

  • Node (Dict)

    • fileId: int
    • path: str
    • mimetype: str
    • etag: str
    • shareToken: str
    • expirationDate: str
    • hasSharePassword: bool
    • shareTime: int
    • canUpload: bool
    • fileSize: int
    • isFavorited: bool
    • mtime: int
    • isPreviewable: bool
    • width: int
    • height: int
  • User (Dict)

    • username: str
    • displayName: str
    • quota: int
    • used: int
    • isAdmin: bool
    • isPremium: bool
    • language: str

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for transip-stack-api, version 1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size transip_stack_api-1.3.0-py2.py3-none-any.whl (15.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size transip-stack-api-1.3.0.tar.gz (12.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page