Official Box Python SDK
Project description
Installing
pip install boxsdkUsage
Get user info
me = client.user(user_id='me').get()
print 'user_login: ' + me['login']Get folder info
root_folder = client.folder(folder_id='0').get()
print 'folder owner: ' + root_folder.owned_by['login']
print 'folder name: ' + root_folder['name']Get items in a folder
items = client.folder(folder_id='0').get_items(limit=100, offset=0)Create subfolder
# creates folder structure /L1/L2/L3
client.folder(folder_id='0').create_subfolder('L1').create_subfolder('L2').create_subfolder('L3')Get file name
client.file(file_id='SOME_FILE_ID').get()['name']Rename an item
client.file(file_id='SOME_FILE_ID').rename('bar-2.txt')Move an item
client.file(file_id='SOME_FILE_ID').move(client.folder(folder_id='SOME_FOLDER_ID'))Get content of a file
client.file(file_id='SOME_FILE_ID').content()Lock/unlock a file
client.file(file_id='SOME_FILE_ID').lock()
client.file(file_id='SOME_FILE_ID').unlock()Search
client.search('some_query', limit=100, offset=0)Events
# Get events
client.events().get_events(limit=100, stream_position='now')
# Generate events using long polling
for event in client.events().generate_events_with_long_polling():
pass # Do something with the event
# Get latest stream position
client.events().get_latest_stream_position()Metadata
# Get metadata
client.file(file_id='SOME_FILE_ID').metadata().get()
# Create metadata
client.file(file_id='SOME_FILE_ID').metadata().create({'key': 'value'})
# Update metadata
metadata = client.file(file_id='SOME_FILE_ID').metadata()
update = metadata.start_update()
update.add('/key', 'new_value')
metadata.update(update)Contributing
See CONTRIBUTING.rst.
Developer Setup
Create a virtual environment and install packages -
mkvirtualenv boxsdk
pip install -r requirements-dev.txtTesting
Run all tests using -
toxThe tox tests include code style checks via pep8 and pylint.
The tox tests are configured to run on Python 2.6, 2.7, 3.3, 3.4, and PyPy.
Support
Need to contact us directly? Email oss@box.com and be sure to include the name of this project in the subject. For questions, please contact us directly rather than opening an issue.
Copyright and License
Copyright 2015 Box, Inc. All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
boxsdk-1.1.7.tar.gz
(65.7 kB
view hashes)
