Skip to main content

Twisted-based async interface for Ubuntu One Files Cloud REST API v1

Project description

txu1

Twisted-based async interface for Ubuntu One Files Cloud REST API v1.

Implemented from scratch on top of Twisted and oauth2 (name might be confusing - it’s actually OAuth 1.0 helper), does not require any ubuntu-specific libs, daemons or modules.

Usage Example

Note that email/password credentials are only needed to get the OAuth 1.0 consumer/token (which can be revoked through ubuntu single sign on interface) once, see docs for more details.

Included “u1-cli” script can also be used to generate these OAuth credentials for the apps.

from twisted.internet import defer, reactor
from txu1 import txU1, DoesNotExist

@defer.inlineCallbacks
def do_stuff():
    api = txU1(debug_requests=True)

    try:
        api.auth_consumer, api.auth_token =\
            (open(n).read().splitlines() for n in ['u1_consumer', 'u1_token'])
    except (OSError, IOError):
        print 'Getting new OAuth credentials'

        # Query credentials from terminal
        email = raw_input('U1 Email: ').strip()
        password = raw_input('U1 Password: ').strip()
        assert email and password, (email, password)

        auth = yield api.auth_create_token(email, password)
        open('u1_consumer', 'w').write('{}\n{}\n'.format(*api.auth_consumer))
        open('u1_token', 'w').write('{}\n{}\n'.format(*api.auth_token))
        print 'Auth data acquired: {}'.format(auth)

    print 'Storage info: {}'.format((yield api.info_storage()))
    print 'Public files: {}'.format((yield api.info_public_files()))

    vol_list = yield api.volume_info(type_filter='udf')
    vol_count = len(vol_list)
    print 'UDF volumes: {}'.format(vol_list)

    try: vol_info = yield api.volume_info('~/test')
    except DoesNotExist:
        vol_info = yield api.volume_create('~/test')
        vol_count += 1
    print 'Using volume: {}'.format(vol_info)
    if vols_count > 1: api.default_volume = '~/test'

    try: print 'dir info: {}'.format((yield api.node_info('/a/b/c', children=True)))
    except DoesNotExist: print 'mkdir: {}'.format((yield api.node_mkdir('/a/b/c')))

    contents = 'somecontents'
    print 'put: {}'.format(
        (yield api.file_put_into('/a/b/c', name='test_file', data=contents)) )
    print 'put_magic: {}'.format(
        (yield api.file_put_magic('/a/b/c/test_file2', data=contents)) )

    print 'get: {}'.format((yield api.file_get('/a/b/c/test_file')))

    print "Hey! I'm running some DELETE operations, don't mind me..."
    yield api.node_delete('/a/b/c/test_file2')
    yield api.node_delete('/a/b/c/test_file')
    yield api.node_delete('/a/b/c')
    yield api.volume_delete('~/test')

    print 'Done'

do_stuff().addBoth(lambda ignored: reactor.stop())
reactor.run()

More comprehensive docs are always welcome!

Installation

It’s a regular package for Python 2.7 (not 3.X).

Using pip is the best way:

% pip install txu1

If you don’t have it, use:

% easy_install pip
% pip install txu1

Alternatively (see also):

% curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python
% pip install txu1

Or, if you absolutely must:

% easy_install txu1

But, you really shouldn’t do that.

Current-git version can be installed like this:

% pip install 'git+https://github.com/mk-fg/txu1.git#egg=txu1'

Note that to install stuff in system-wide PATH and site-packages, elevated privileges are often required. Use “install –user”, ~/.pydistutils.cfg or virtualenv to do unprivileged installs into custom paths.

Requirements

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
txu1-13.06.0.tar.gz (14.0 kB) Copy SHA256 hash SHA256 Source None

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