{ "info": { "author": "Daniel Flehner Heen", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7" ], "description": "Welcome to pyfilemail's documentation!\n======================================\n\nPyfilemail is a command line tool and API for sending and recieving files with `Filemail `_\nbased on `requests `_ and filemail's `API `_.\n\nTo avoid nagging about API KEY you should register and get one `here `_.\nIf you register for a paid plan you unlock all features and will be able to add/delete/update your transfers/contacts/group/company settings.\nWithout registering you'll still be able to send files as a free plan user but remember to use the ``--free`` argument in the command line tool.\n\nFor more info on the different plans please go to `Filemail `_\n\nI've tried to keep this api as simple as possible and rely on filemail's own validation of data to keep you all in check :)\nThe reason for this is that I don't work at filemail and have no insight in what validation they have for the data passed.\nIt also saves me a lot of head ache writing rock solid validation code and I think this is a more flexible way of doing it if the Filemail team decides to change\nthe API in any way.\n\nAppart from ``pyfilemail.User`` and ``pyfilemail.Transfer`` classes, all return objects from filemail are ``dict`` objects based on json responses.\n\nSo far this has been developed and tested on Ubuntu 16.04.\nI'll try to get my hands on a Windows and OSX machine and addapt the code to make sure it works there as well.\n\nAPI documentation is available at `readthedocs `_\n\nAny feedback is more than welcome and please report bugs through `github `_\n\nInstallation\n============\n.. code-block:: bash\n\n pip install pyfilemail\n\nDisclaimer\n==========\nI use this software myself and have not yet experienced broken files, but I take no responsibility for the files sent or received using pyfilemail whether it comes to content or state of files passing through.\nPyfilemail is still work in progress and parts of the API might change as I develop and test it further.\n\n\nCommand line example\n====================\n\n.. code-block:: bash\n\n pyfilemail \\\n --from myemail@somedomain.com \\\n --to lucky.b@receiver.com \\\n --free \\\n --subject \"Amazing document!\" \\\n --message \"Have you seen how amazingly big this document is?\" \\\n --payload /path/to/file.ext /path/to/folder/\n\nAdd API KEY\n===========\n\nYou can add the API KEY to the local config file with the ``--add-api-key`` argumet.\n\n.. code-block:: bash\n\n pyfilemail --add-api-key YOUR-API-KEY-FROM-FILEMAIL\n\nnetrc\n======\nYou may use a .netrc file to store login information. Make sure you restrict access to only allow your own user to read it.\n\n.. code-block:: bash\n\n #$HOME/.netrc example:\n machine yourfilemailuser@email.com\n login yourfilemailuser@email.com\n password topsecretpassword\n\nCommand line help\n=================\n\n.. code-block:: bash\n\n usage: pyfilemail [-h] [--version] [--add-api-key ADD_API_KEY] [--free] [-nc]\n [--compress] [--confirm] [--quiet] [--days 3]\n [--downloads 0] [--message MESSAGE] [--notify]\n [--subject SUBJECT]\n [--to recipient@receiver.com [recipient@receiver.com ...]]\n [--password PASSWORD] [--from USERNAME] [--store-password]\n [--delete-password] [--payload PAYLOAD [PAYLOAD ...]]\n\n Command line Filemail transfer through Python\n\n optional arguments:\n -h, --help show this help message and exit\n --version show program's version number and exit\n --add-api-key ADD_API_KEY\n Add API KEY from Filemail to local config file\n --free Send files without a registered Filemail account\n -nc, --no-checksum Skip calculating checksum on added files\n --compress Compress (ZIP) data before sending?\n --confirm Email confirmation after sending the files?\n --quiet Log only warnings to console\n --days 3 Number of days the file(s) are available for download\n --downloads 0 Number of times the file(s) may be downloaded.\n 0=unlimited\n --message MESSAGE Message to the recipient(s) of the transfer\n --notify Notify when recipients download your files?\n --subject SUBJECT Subject of email sent with transfer\n --to recipient@receiver.com [recipient@receiver.com ...]\n Recipient(s) of the transfer (email addresses)\n --password PASSWORD Protect transfer with the supplied password\n --from USERNAME Your email address\n --store-password Store user password in keychain if available\n --delete-password Delete password stored in keychain\n --payload PAYLOAD [PAYLOAD ...]\n File(s) and/or folder(s) to transfer\n\nPython API examples\n===================\n\n.. code-block:: python\n\n import pyfilemail\n\n # Setup a transfer\n\n # Initialize Filemail with as free (as in free beer) user\n user = pyfilemail.User(username='user@mailprovider.com')\n\n transfer = pyfilemail.Transfer(user,\n to='lucky@recipient.com',\n subject='My BIG file no email can handle',\n message='You will not belive the speed of this download!',\n notify=True,\n confirmation=True,\n days=7,\n password='JuSt2BeSaf\u00a3')\n\n # Add a single file to transfer queue\n transfer.add_files('/path/to/my/BIG_file.ext')\n\n # Add multiple files\n list_of_files = ['/path/to/my/BIG_file_1.ext',\n '/path/to/my/BIG_file_2.ext',\n '/path/to/my/BIG_file_3.ext']\n\n transfer.add_files(list_of_files)\n\n # Send files to recipient(s)\n transfer.send(auto_complete=True)\n\n # Login to a registered Filemail account\n user = pyfilemail.User(username='user@mailprovider.com',\n password='YourSecretPassword2014')\n\n # List all prior transfers\n transfers = user.get_sent(expired=True)\n\n # Get contacts\n user.get_contacts()\n\n # Get one single contact\n contact = user.get_contact('contact@email.address.com')\n\n # Update that contact\n contact['name'] = 'Mr. Orange'\n user.update_contact(contact)\n\n # Delete contact\n unfriendly = user.get_contact('contact@email.address.com')\n user.delete_contact(unfriendly)\n\n # Download received transfers for the past 7 days\n transfers = user.get_received(age=7)\n for transfer in transfers:\n transfer.download(destination='/home/myname/Downloads')\n\n # Logout\n user.logout()\n\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "https://github.com/apetrynet/pyfilemail/tarball/0.5.1", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/apetrynet/pyfilemail", "keywords": "filemail,pyfilemail,file transfer,large file transfer,fast transfer,transfer,fast", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "pyfilemail", "package_url": "https://pypi.org/project/pyfilemail/", "platform": "", "project_url": "https://pypi.org/project/pyfilemail/", "project_urls": { "Download": "https://github.com/apetrynet/pyfilemail/tarball/0.5.1", "Homepage": "https://github.com/apetrynet/pyfilemail" }, "release_url": "https://pypi.org/project/pyfilemail/0.5.1/", "requires_dist": [ "requests", "requests-toolbelt", "appdirs", "keyring", "clint" ], "requires_python": "", "summary": "Python command line tool and API for file transfers with www.filemail.com", "version": "0.5.1" }, "last_serial": 3156096, "releases": { "0.3.0": [ { "comment_text": "", "digests": { "md5": "667303150b39eb408cfd9ef2a68e8699", "sha256": "c46378aedf9ed3d5640c7c0bc86e7d4198bcd0ed393b3dbf3ee95af47f86326b" }, "downloads": -1, "filename": "pyfilemail-0.3.0-py2-none-any.whl", "has_sig": false, "md5_digest": "667303150b39eb408cfd9ef2a68e8699", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 19835, "upload_time": "2016-06-06T22:29:29", "url": "https://files.pythonhosted.org/packages/c9/ee/8a1cac6378ee83c40ce0dc69c73fe7534bfa085daad6fbb8a2656db4ce00/pyfilemail-0.3.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3d3fa61b30c6f0db6abca6dcc9e48595", "sha256": "cb1ec3d7bef665cea96794da572bbf2ae57ee2fe140327d2f3d1e384108e4e14" }, "downloads": -1, "filename": "pyfilemail-0.3.0.tar.gz", "has_sig": false, "md5_digest": "3d3fa61b30c6f0db6abca6dcc9e48595", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14676, "upload_time": "2016-06-06T22:29:33", "url": "https://files.pythonhosted.org/packages/e4/19/b3c8331cf0b10bc6de59217482124ad06c679eb024685684ddc4c0a4c891/pyfilemail-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "cb82aea72dbc566b425bf8b5fe948076", "sha256": "1b4678a3cc62379b86042e4911e092f7280d9c3bb2f771a01191087b0aadcb22" }, "downloads": -1, "filename": "pyfilemail-0.3.1-py2-none-any.whl", "has_sig": false, "md5_digest": "cb82aea72dbc566b425bf8b5fe948076", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 19840, "upload_time": "2016-06-09T16:46:29", "url": "https://files.pythonhosted.org/packages/cf/4a/82c5dd40a467cd656cf6cb9f28c91cd53571eb48e74cb0f99b0edcbd904a/pyfilemail-0.3.1-py2-none-any.whl" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "74f82971bbccb637c846c15471eb7f00", "sha256": "4f2122b30a96367f24a114ae02ffad21f1c119e95990f14a1620c5f34e48e529" }, "downloads": -1, "filename": "pyfilemail-0.3.2-py2-none-any.whl", "has_sig": false, "md5_digest": "74f82971bbccb637c846c15471eb7f00", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 19841, "upload_time": "2016-06-09T16:51:38", "url": "https://files.pythonhosted.org/packages/94/3a/5947a2267d87d37e4d34b498bf4960264102eb02ed04eb996c5ebc09860c/pyfilemail-0.3.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5155b871a838d66300908122f7e2f52d", "sha256": "04452849c3b56f952cc4d455a1bdacc67677ffe741e184ccc2bc8ab395529c6c" }, "downloads": -1, "filename": "pyfilemail-0.3.2.tar.gz", "has_sig": false, "md5_digest": "5155b871a838d66300908122f7e2f52d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14698, "upload_time": "2016-06-09T16:51:52", "url": "https://files.pythonhosted.org/packages/8b/fd/822fed0a669763b4365925a469707805310cf4a1ce64ff71beca85923557/pyfilemail-0.3.2.tar.gz" } ], "0.3.3": [ { "comment_text": "", "digests": { "md5": "a06ee05907172ebb2bd4b52710fcf35e", "sha256": "8d8934a3126a8f18a16733ef6e2380e7a807e986c787be124742015e4c6267e4" }, "downloads": -1, "filename": "pyfilemail-0.3.3.tar.gz", "has_sig": false, "md5_digest": "a06ee05907172ebb2bd4b52710fcf35e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14920, "upload_time": "2016-06-13T19:12:35", "url": "https://files.pythonhosted.org/packages/68/36/d5cb5dc5e282882d1a01790baae27d638da686be9c4018f9eb4c9a532976/pyfilemail-0.3.3.tar.gz" } ], "0.3.4": [ { "comment_text": "", "digests": { "md5": "9cc12988185a9a8ed188a77a88e16b41", "sha256": "9c3f0df200dfa801be1e6f38bed1e554e7b9deadd20fe035fc0e0d63d3244332" }, "downloads": -1, "filename": "pyfilemail-0.3.4-py2-none-any.whl", "has_sig": false, "md5_digest": "9cc12988185a9a8ed188a77a88e16b41", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 20349, "upload_time": "2016-06-30T19:25:18", "url": "https://files.pythonhosted.org/packages/06/8f/46c33b636c5a2b0a3e6acbbbd95ce05ccfdd7c177416ad9300cf84780eee/pyfilemail-0.3.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7a2b78bc95856cb619c62ef39942e163", "sha256": "46f2039ef99aa52111075a0b230f97f9b324650d8778d648470384150ce37e4c" }, "downloads": -1, "filename": "pyfilemail-0.3.4.tar.gz", "has_sig": false, "md5_digest": "7a2b78bc95856cb619c62ef39942e163", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15055, "upload_time": "2016-06-20T21:35:04", "url": "https://files.pythonhosted.org/packages/6b/ae/14c13695a1d170864dfdda60f1ab058faca3ca469b32ca7d694b0fef1d20/pyfilemail-0.3.4.tar.gz" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "244802bbcfd8fabd18127a339fafd28e", "sha256": "1d068157bd2d039a6ea27f06557fca11b9f28c79786922d232ac044ba4560e80" }, "downloads": -1, "filename": "pyfilemail-0.4.1.tar.gz", "has_sig": false, "md5_digest": "244802bbcfd8fabd18127a339fafd28e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15557, "upload_time": "2017-03-01T17:00:26", "url": "https://files.pythonhosted.org/packages/a1/a4/fda1621b5a11ce479c6e633d50147d2d3a2248d4d6b2f06aafd61c57e4ef/pyfilemail-0.4.1.tar.gz" } ], "0.4.2": [ { "comment_text": "", "digests": { "md5": "930a86b6f4233f370dcd1190751a6057", "sha256": "d5be2e96b92ca6ac00c19cd95674646cd773ef85de7d004e26727c948c9315cc" }, "downloads": -1, "filename": "pyfilemail-0.4.2-py2-none-any.whl", "has_sig": false, "md5_digest": "930a86b6f4233f370dcd1190751a6057", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 20887, "upload_time": "2017-03-02T08:25:22", "url": "https://files.pythonhosted.org/packages/e7/e7/439c92dd1dd4e760b9b43b42e8d568a502d20207927a84b85dc7bb6e2934/pyfilemail-0.4.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a269e3bcde67a7f2cfd8e897dca63ac5", "sha256": "e165c98700029092724c11c53ccd9efc7e77b54ebd4a3287079d8434e2072559" }, "downloads": -1, "filename": "pyfilemail-0.4.2.tar.gz", "has_sig": false, "md5_digest": "a269e3bcde67a7f2cfd8e897dca63ac5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15560, "upload_time": "2017-03-02T08:25:24", "url": "https://files.pythonhosted.org/packages/12/b8/d36f8b94e863cbeeb2e3196a31e06a6033241bd28f65d04ec6cdad1007ad/pyfilemail-0.4.2.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "6a1aae7d3a8b2a4b059202981cc1323c", "sha256": "87c5bc9b5872005d82234721f2c1f3766d14d49ec48ce8d8ebed6a7f8cbde939" }, "downloads": -1, "filename": "pyfilemail-0.5.0-py2-none-any.whl", "has_sig": false, "md5_digest": "6a1aae7d3a8b2a4b059202981cc1323c", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 21384, "upload_time": "2017-03-09T15:34:51", "url": "https://files.pythonhosted.org/packages/60/06/3f2f599e866b133f3305461163d959a25a8fdc2f1f1901a007970c33a6ca/pyfilemail-0.5.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ad33bb12ae35bd762c47d10deea2143f", "sha256": "b1b32ea18e9566ab61ad3af3d4f91ddbbaf458920524b39a3a39090442972a2a" }, "downloads": -1, "filename": "pyfilemail-0.5.0.tar.gz", "has_sig": false, "md5_digest": "ad33bb12ae35bd762c47d10deea2143f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15918, "upload_time": "2017-03-09T15:34:54", "url": "https://files.pythonhosted.org/packages/4f/dd/612c67c6a018343aff9f5f9c8caed1f4fbd62fa323d34fb86507d4d7dea0/pyfilemail-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "d9075bb9851c870d5e8b0e76a65d15da", "sha256": "0eff49f0265a08e0d05abfb2999a9b51c2b4d1b7077520175752272bcdedf69f" }, "downloads": -1, "filename": "pyfilemail-0.5.1-py2-none-any.whl", "has_sig": false, "md5_digest": "d9075bb9851c870d5e8b0e76a65d15da", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 21453, "upload_time": "2017-09-07T11:30:14", "url": "https://files.pythonhosted.org/packages/95/61/2f737f4288f51b3ca59d66dabb90d90e02d0c6456cfb73535f32b7890673/pyfilemail-0.5.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9163bd43be385a5cde1a141d1d9e1518", "sha256": "b729637bfe8e2d98600de8520e0786272bbe114ccd706d36067191dac2861bae" }, "downloads": -1, "filename": "pyfilemail-0.5.1.tar.gz", "has_sig": false, "md5_digest": "9163bd43be385a5cde1a141d1d9e1518", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15961, "upload_time": "2017-09-07T11:30:16", "url": "https://files.pythonhosted.org/packages/ac/4a/ea0e540284a8cea1870ed980cbec9433c51ae4078c559066737c1ef2e382/pyfilemail-0.5.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d9075bb9851c870d5e8b0e76a65d15da", "sha256": "0eff49f0265a08e0d05abfb2999a9b51c2b4d1b7077520175752272bcdedf69f" }, "downloads": -1, "filename": "pyfilemail-0.5.1-py2-none-any.whl", "has_sig": false, "md5_digest": "d9075bb9851c870d5e8b0e76a65d15da", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 21453, "upload_time": "2017-09-07T11:30:14", "url": "https://files.pythonhosted.org/packages/95/61/2f737f4288f51b3ca59d66dabb90d90e02d0c6456cfb73535f32b7890673/pyfilemail-0.5.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9163bd43be385a5cde1a141d1d9e1518", "sha256": "b729637bfe8e2d98600de8520e0786272bbe114ccd706d36067191dac2861bae" }, "downloads": -1, "filename": "pyfilemail-0.5.1.tar.gz", "has_sig": false, "md5_digest": "9163bd43be385a5cde1a141d1d9e1518", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15961, "upload_time": "2017-09-07T11:30:16", "url": "https://files.pythonhosted.org/packages/ac/4a/ea0e540284a8cea1870ed980cbec9433c51ae4078c559066737c1ef2e382/pyfilemail-0.5.1.tar.gz" } ] }