Readme
This is a Python implementation of MediaFire Core API_ client.
.. _MediaFire Core Api: http://www.mediafire.com/developers/core_api/
.. code-block:: bash
$ pip install mediafire
If you are in a hurry, use MediaFireClient - it contains enough functions to
get your uploads/downloads and file listings working. It does not have a stable API,
and has rudimentary test coverage only.
You may want to stick to MediaFireApi and MediaFireUploader to have as much
control as possible over your application flow.
API Client library provides an interface to MediaFire API. It handles requests, responses, signatures and errors.
Usage:
.. code-block:: python
from mediafire import MediaFireApi
api = MediaFireApi()
session = api.user_get_session_token(
email='your.email@example.net',
password='password',
app_id='42511')
# API client does not know about the token
# until explicitly told about it:
api.session = session
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://forum.mediafiredev.com/images/mfforumlogo.png",
"filename": "mfforumlogo.png"})
response = api.request("upload/get_web_uploads",
{"key": response['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:
.. code-block:: python
from mediafire import MediaFireApi
api = MediaFireApi()
response = api.system_get_info()
print(response) # prints system info
response = api.user_get_info() # fails with "Session token is missing"
Once set, session token can be unset:
.. code-block:: python
api.session = None
# or
del api.session
For information on wrapped methods, see pydoc mediafire.api. For
documentation on actual values expected, see MediaFire Core API_
documentation.
All wrapped methods follow the same naming convention, category_action, so
upload/instant is upload_instant.
You can construct the call yourself easily:
.. code-block:: python
response = api.request("user/set_avatar",
{"quick_key": "123456789012345"})
API client does not handle regular file downloads because these are simple HTTP requests to URLs returned by "file/get_links". Here's how you can do that yourself:
.. code-block:: python
response = api.file_get_links('c94lcpx3vax6xp3')
normal_download_url = response['links'][0]['normal_download']
response = requests.get(normal_download_url, stream=True)
with io.open("/tmp/green.jpg", 'wb') as fd:
for chunk in response.iter_content(chunk_size=4096):
fd.write(chunk)
In case response is a file download, e.g. file/zip, the response returned
is a requests.Response_ object, which you can read from:
.. code-block:: python
...
response = api.request("file/zip", {"keys": "c94lcpx3vax6xp3"})
with io.open("/tmp/green.zip", 'wb') as fd:
for chunk in response.iter_content(chunk_size=4096):
fd.write(chunk)
...
.. _requests.Response: http://docs.python-requests.org/en/latest/api/#requests.Response
See Download_ documentation for more information.
.. _Download: http://www.mediafire.com/developers/core_api/1.2/download/
MediaFire supports several upload methods and MediaFireUploader exposes a
single upload method to make things easier:
.. code-block:: python
from mediafire import (MediaFireApi, MediaFireUploader)
api = MediaFireApi()
uploader = MediaFireUploader(api)
# ... authenticate ...
fd = open('/path/to/file', 'rb')
result = uploader.upload(fd, 'Some filename.txt',
folder_key='1234567890123')
pprint(api.file_get_info(result.quickkey))
result is a mediafire.uploader.UploadResult instance.
For FileDrop uploads (i.e. when filedrop_key is used) only upload/instant
result has quickkey. upload/instant and upload/resumable return
None for all the fields, since upload/poll does not support
encrypted upload key.
This API is subject to change
This is a very thin layer on top of Image and Document conversion API.
.. code-block:: python
from mediafire.media import ConversionServerClient
conv = ConversionServerClient()
response = conv.request('2004', 'm8d6blce79xhxl5', 'i', size_id='1')
with open('/tmp/example.jpg', 'rb') as fd:
fd.write(response.content)
This API is subject to change
High-level client library wraps API calls and presents simplified interface.
Supported operations:
MediaFire resources can be referenced by path or by quickkey/folderkey.
mf:/Pictures/Sample.jpg or /Pictures/Sample.jpgmf:6302u1a9p0a9x (folder_key is 13 chars long)mf:46d3y4p8542kiyp (quick_key is 15 chars long).. code-block:: python
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['name']))
See examples/mediafire-cli.py for high-level client usage.
Test suite is located under tests/
.. code-block:: bash
git clone https://github.com/MediaFire/mediafire-python-open-sdk.git
cd mediafire-python-open-sdk
# Run tests with python 3 interpreter
PYTHONPATH=. python3 -munittest
# Run tests with python 2 interpreter
PYTHONPATH=. python -munittest discover
See https://pypi.org/project/mediafire/ for the current maintainer.
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.
FAQs
Python MediaFire client library
We found that mediafire demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.