Examples (#252)

* Examples

* upload script

* moved examples

* tidy

Author: willmcgugan

examples/README.txt

@@ -0,0 +1,3 @@
+This directory contains a number of example command line apps using PyFilesystem.
+
+They are intended to be a learning aid and not exactly finished products, but all these examples are completely functional.

examples/count_py.py

@@ -0,0 +1,22 @@
+"""
+Display how much storage is used in your Python files.
+
+Usage:
+    python count_py.py <PATH or FS URL>
+
+"""
+
+import sys
+
+from fs import open_fs
+from fs.filesize import traditional
+
+
+fs_url = sys.argv[1]
+count = 0
+
+with open_fs(fs_url) as fs:
+    for _path, info in fs.walk.info(filter=["*.py"], namespaces=["details"]):
+        count += info.size
+
+print(f'There is {traditional(count)} of Python in "{fs_url}"')

examples/find_dups.py

@@ -0,0 +1,40 @@
+"""
+Find paths to files with identical contents.
+
+Usage:
+
+    python find_dups.py <PATH or FS URL>
+
+"""
+
+from collections import defaultdict
+import hashlib
+import sys
+
+from fs import open_fs
+
+
+def get_hash(bin_file):
+    """Get the md5 hash of a file."""
+    file_hash = hashlib.md5()
+    while True:
+        chunk = bin_file.read(1024 * 1024)
+        if not chunk:
+            break
+        file_hash.update(chunk)
+    return file_hash.hexdigest()
+
+
+hashes = defaultdict(list)
+with open_fs(sys.argv[1]) as fs:
+    for path in fs.walk.files():
+        with fs.open(path, "rb") as bin_file:
+            file_hash = get_hash(bin_file)
+        hashes[file_hash].append(path)
+
+for paths in hashes.values():
+    if len(paths) > 1:
+        for path in paths:
+            print(f" {path}")
+        print()
+

examples/rm_pyc.py

@@ -0,0 +1,17 @@
+"""
+Remove all pyc files in a directory.
+
+Usage:
+
+    python rm_pyc.py <PATH or FS URL>
+
+"""
+
+import sys
+
+from fs import open_fs
+
+
+with open_fs(sys.argv[1]) as fs:
+    count = fs.glob("**/*.pyc").remove()
+print(f"{count} .pyc files remove")

examples/upload.py

@@ -0,0 +1,29 @@
+"""
+Upload a file to a server (or other filesystem)
+
+Usage:
+
+    python upload.py FILENAME <FS URL>
+
+example:
+
+    python upload.py foo.txt ftp://example.org/uploads/
+
+
+"""
+
+import os
+import sys
+
+from fs import open_fs
+
+_, file_path, fs_url = sys.argv
+filename = os.path.basename(file_path)
+
+with open_fs(fs_url) as fs:
+    if fs.exists(filename):
+        print("destination exists! aborting.")
+    else:
+        with open(file_path, "rb") as bin_file:
+            fs.upload(filename, bin_file)
+print("upload successful!")