Dropbox Python API: Uploading a file

Question

I would like to know how to use the dropbox library in Python 2.7 to upload a file to my Dropbox.

I have successfully connected to my Dropbox and the Dropbox object is called db.

How to do this?

Have you tried anything and run into a problem? If so, post your code and the error. Or are you just asking us to post a link to the documentation? — Aran-Fey
– Aran-Fey, Commented Apr 30, 2017 at 17:39
I don't believe the Dropbox class is meant for public consumption because they don't document it on their API docs - I only found it in the source code. Do you mind a solution with the DropboxClient, that is the one I'm familiar with and that's also the one that is documented for public use? — EyuelDK
– EyuelDK, Commented Apr 30, 2017 at 17:39

Graham · Accepted Answer · 2017-09-25 22:54:56Z

The Dropbox Python SDK provides both API v1 and API v2 functionality for backwards compatibility, but only API v2 should be used now, as API v1 is deprecated. The tutorial covers the basic of using the API v2 functionality.

This uses the Dropbox Python SDK to download a file from the Dropbox API at the remote path /Homework/math/Prime_Numbers.txt to the local file Prime_Numbers.txt:

import dropbox
dbx = dropbox.Dropbox("<ACCESS_TOKEN>")

with open("Prime_Numbers.txt", "wb") as f:
    metadata, res = dbx.files_download(path="/Homework/math/Prime_Numbers.txt")
    f.write(res.content)

<ACCESS_TOKEN> should be replaced with your access token.

And for uploading:

This uses the Dropbox Python SDK to upload a file to the Dropbox API from the local file as specified by file_path to the remote path as specified by dest_path. It also chooses whether or not to use an upload session based on the size of the file:

f = open(file_path)
file_size = os.path.getsize(file_path)

CHUNK_SIZE = 4 * 1024 * 1024

if file_size <= CHUNK_SIZE:

    print dbx.files_upload(f.read(), dest_path)

else:

    upload_session_start_result = dbx.files_upload_session_start(f.read(CHUNK_SIZE))
    cursor = dropbox.files.UploadSessionCursor(session_id=upload_session_start_result.session_id,
                                               offset=f.tell())
    commit = dropbox.files.CommitInfo(path=dest_path)

    while f.tell() < file_size:
        if ((file_size - f.tell()) <= CHUNK_SIZE):
            print dbx.files_upload_session_finish(f.read(CHUNK_SIZE),
                                            cursor,
                                            commit)
        else:
            dbx.files_upload_session_append(f.read(CHUNK_SIZE),
                                            cursor.session_id,
                                            cursor.offset)
            cursor.offset = f.tell()

f.close()

EyuelDK · Accepted Answer · 2017-04-30 18:29:58Z

0

Note

This is API v1, which is now being deprecated. Use with care or use the currently supported APIs.

Initialize Dropbox client

import dropbox
access_token = 'SOME_ACCESS_TOKEN'
client = dropbox.client.DropboxClient(access_token)

Upload file

src_file = open('SOME_LOCAL_FILE', 'r')
response = client.put_file('SOME_REMOTE_FILE', src_file)

Download file

dest_file = open('SOME_LOCAL_FILE', 'w')
with client.get_file('SOME_REMOTE_FILE') as src_file:
    dest_file.write(src_file.read())

Reference

For more concise API documentation please refer to Core API for Python Documentation

edited Apr 30, 2017 at 18:29

answered Apr 30, 2017 at 17:49

EyuelDK

3,2392 gold badges21 silver badges28 bronze badges

3 Comments

Brendan Lewis Over a year ago

Thank you very much! I will test it soon (~30 minutes) and mark this answer as accepted if it works.

Aran-Fey Over a year ago

This code uses the deprecated API v1, which will be turned off in 2 months.

EyuelDK Over a year ago

@Rawing Thx for the heads up. I used this API years ago and I didn't realize it was being pushed out. I'll note that on my answer.

jahmed31 · Accepted Answer · 2017-09-30 12:29:30Z

f = open(file_path)
file_size = os.path.getsize(file_path)
CHUNK_SIZE = 4 * 1024 * 1024

if file_size <= CHUNK_SIZE:
    print dbx.files_upload(f, dest_path)
else:
    upload_session_start_result = dbx.files_upload_session_start(f.read(CHUNK_SIZE))

    cursor = dropbox.files.UploadSessionCursor(session_id=upload_session_start_result.session_id, offset=f.tell())
    commit = dropbox.files.CommitInfo(path=dest_path)

    while f.tell() < file_size:
        commit = dropbox.files.CommitInfo(path=dest_path)    
        if ((file_size - f.tell()) <= CHUNK_SIZE):
            print dbx.files_upload_session_finish(f.read(CHUNK_SIZE),                               
                                                          cursor,
                                                          commit)
        else:
            dbx.files_upload_session_append(f.read(CHUNK_SIZE),cursor.session_id, cursor.offset)
           cursor.offset = f.tell()

Collectives™ on Stack Overflow

Dropbox Python API: Uploading a file

3 Answers 3

Comments

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related