README.md: Add a README to briefly document transferwee - transferwee - Download/upload file via wetransfer.com
(HTM) git clone https://github.com/iamleot/transferwee
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
---
(DIR) commit 5a9d91dabf54b03c5e7663bc893fb4d1a71e9830
(DIR) parent bc502b6b7558d6583b79edeb3c528bc996b4e49a
(HTM) Author: Leonardo Taccari <iamleot@gmail.com>
Date: Tue, 8 May 2018 01:42:33 +0200
README.md: Add a README to briefly document transferwee
Diffstat:
A README.md | 72 +++++++++++++++++++++++++++++++
1 file changed, 72 insertions(+), 0 deletions(-)
---
(DIR) diff --git a/README.md b/README.md
@@ -0,0 +1,72 @@
+# transferwee
+
+transferwee is a simple Python 3 script to download/upload files via
+wetransfer.com.
+
+
+## Usage
+
+```
+% transferwee -h
+usage: transferwee [-h] {download,upload} ...
+
+Download/upload files via wetransfer.com
+
+positional arguments:
+ {download,upload} action
+ download download files
+ upload upload files
+
+optional arguments:
+ -h, --help show this help message and exit
+```
+
+### Upload files
+
+`upload` subcommand uploads all the files and then print the shorten
+URL corresponding the transfer.
+
+If both `-f` option and `-t` option are passed the email upload
+will be used (in that way the sender will get an email after the
+upload and after every recipient will download the file).
+Otherwise the link upload will be used.
+
+```
+% transferwee upload -h
+usage: transferwee upload [-h] [-m message] [-f from] [-t to [to ...]]
+ file [file ...]
+
+positional arguments:
+ file files to upload
+
+optional arguments:
+ -h, --help show this help message and exit
+ -m message message description for the transfer
+ -f from sender email
+ -t to [to ...] recipient emails
+```
+
+
+### Download file
+
+`download` subcommand download all the files from the given
+we.tl/wetransfer.com URLs.
+
+If the `-g` option is used it will just print the direct link
+corresponding each URLs without downloading files.
+
+```
+% transferwee download -h
+usage: transferwee download [-h] [-g] url [url ...]
+
+positional arguments:
+ url URL (we.tl/... or wetransfer.com/downloads/...)
+
+optional arguments:
+ -h, --help show this help message and exit
+ -g only print the direct link (without downloading it)
+```
+
+## Dependencies
+
+transferwee needs [requests](http://python-requests.org/) package.