Skip to main content

Python MediaFire client library

Project description

Python implementation of MediaFire Core API.

This SDK contains three entities: API client, uploader and high-level client.

https://travis-ci.org/roman-yepishev/mediafire-python-open-sdk.svg?branch=master

What should I use?

High-level client is a work in progress, so you may want to stick to MediaFireApi and MediaFireUploader as these are covered by tests.

If you don’t mind having breaking changes introduced here and there as the high-level API is being shaped, then use MediaFireClient.

API Client library

API Client library provides a low-level interface to MediaFire API. It handles requests, signatures and errors. Uses python-requests for streaming uploads and does not require the whole file to be loaded in memory.

Usage:

from mediafire.api import MediaFireApi

api = MediaFireApi()
session_result = api.user_get_session_token(
    email='your.email@example.net',
    password='password',
    app_id='42511')

api.set_session_token(session_result)

response = api.user_get_info()
print(response['user_info']['display_name'])

# Or directly for methods that are not yet wrapped
response = api.request("upload/add_web_upload", {
    "url": "http://www.mediafire.com/images/brand-assets/mf-logo.png",
    "filename": "mf-logo.png"})

response = api.request("upload/get_web_uploads",
                    {"key": status['upload_key']})

API Client library supports operation w/o session_token. In this case all operations that do require session_token will fail with Access denied error.

Uploader

MediaFire supports several upload methods and MediaFireUploader exposes a single upload method to make things easier:

from mediafire.api import MediaFireApi
from mediafire.uploader import MediaFireUploader

api = MediaFireApi()
uploader = MediaFireUploader(api)

fd = open('/path/to/file', 'rb')

result = uploader.upload(fd, 'Some filename.txt',
                         folder_key='1234567890123')

pprint(api.file_get_info(result.quickkey))

High-level Client Library

High-level client library wraps API calls and presents simplified interface.

Supported operations:

  • File upload

  • File download (direct download link)

  • Listing directories

  • Creating directories

  • Removing files and directories

  • Getting info about files and directories

MediaFire resources can be referenced by path or by quickkey/folderkey.

  • path: mf:/Pictures/Sample.jpg or /Pictures/Sample.jpg

  • folder_key: mf:6302u1a9p0a9x (folder_key is 13 chars long)

  • quick_key: mf:46d3y4p8542kiyp (quick_key is 15 chars long)

from mediafire.client import (MediaFireClient, File, Folder)

client = MediaFireClient()
client.login(email='your.email@example.net',
    password='password',
    app_id='42511')

client.upload_file("flower.jpg", "mf:/Pictures/")
client.download_file("mf:/Pictures/flower.jpg",
                     "flower-from-mediafire.jpg")

for item in client.get_folder_contents_iter("mf:/Pictures"):
    if type(item) is File:
        print("File: {}".format(item['filename']))
    elif type(item) is Folder:
        print("Folder: {}".format(item['foldername']))

See examples/mediafire-cli.py for high-level client usage.

Example CLI Interface

Work in progress. Can be used for basic tasks, such as directory listing, uploads, downloads, getting resource information and removing files and folders from the command line.

usage: examples/mediafire-cli.py [-h] [--debug] [--email EMAIL] [--password PASSWORD]
                 {ls,file-upload,file-download,folder-create,resource-delete,
                  file-update-metadata,folder-update-metadata,debug-get-resource}
                 ...

Command-line interface to MediaFire Simple File Sharing and Storage

optional arguments:
-h, --help            show this help message and exit
--debug               Enable debug output
--email EMAIL
--password PASSWORD

Actions:
{ls,file-upload,file-download,folder-create,resource-delete,file-update-metadata,
 folder-update-metadata,debug-get-resource}
ls                  List directory contents
file-upload         Upload files
file-download       Download file
folder-create       Create folder
resource-delete     Delete resource
file-update-metadata
                    Update file metadata
folder-update-metadata
                    Update folder metadata
debug-get-resource  Get resource info (debug)

Use –debug option to see API calls and internal debug information.

Requirements

  • python 2.7 or 3.4

  • six

  • requests

  • requests_toolbelt

  • responses (for testing)

Installing

$ pip install mediafire

Tests

Test suite is located under tests/

Run it with:

cd mediafire-python-open-sdk
PYTHONPATH=. python3 -munittest

About and License

Copyright (c) 2014, Roman Yepishev. All rights reserved. Website : http://www.keypressure.com

This project was forked by MediaFire with explicit permission from Roman Yepishev on 10.24.2014

This project is made under BSD license. See LICENSE file for more information.

MediaFire® is a registered trademark of the MediaFire, LLC.

Project details


Download files

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

Source Distribution

mediafire-0.2.0.tar.gz (16.5 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page