lfss 0.8.3__py3-none-any.whl → 0.8.4__py3-none-any.whl

Readme.md

@@ -1,9 +1,17 @@
 # Lightweight File Storage Service (LFSS)
 [![PyPI](https://img.shields.io/pypi/v/lfss)](https://pypi.org/project/lfss/)
 
-My experiment on a lightweight and high-performance file/object storage service.  
+My experiment on a lightweight and high-performance file/object storage service...  
+
+**Highlights:**
+
+- User storage limit and access control.
+- Pagination and sorted file listing for vast number of files.  
+- High performance: high concurrency, near-native speed on stress tests.
+- Support range requests, so you can stream large files / resume download.
+
 It stores small files and metadata in sqlite, large files in the filesystem.  
-Tested on 2 million files, and it works fine... 
+Tested on 2 million files, and it is still fast.
 
 Usage: 
 ```sh
@@ -22,8 +30,8 @@ lfss-panel --open
 Or, you can start a web server at `/frontend` and open `index.html` in your browser. 
 
 The API usage is simple, just `GET`, `PUT`, `DELETE` to the `/<username>/file/url` path.  
-Authentication is done via `Authorization` header with the value `Bearer <token>`, or through the `token` query parameter.  
-You can refer to `frontend` as an application example, and `frontend/api.js` or `lfss/api/connector.py` for the API usage.
+Authentication via `Authorization` header with the value `Bearer <token>`, or through the `token` query parameter.  
+You can refer to `frontend` as an application example, `lfss/api/connector.py` for more APIs. 
 
 By default, the service exposes all files to the public for `GET` requests, 
 but file-listing is restricted to the user's own files.  

frontend/thumb.js

@@ -39,10 +39,14 @@ function getIconSVGFromMimeType(mimeType){
         return ICON_ZIP;
     }
     if ([
-        "text/html", "application/xhtml+xml", "application/xml", "text/css", "application/javascript", "text/javascript", "application/json", "text/x-python", "text/x-java-source",
-        "application/x-httpd-php", "text/x-ruby", "text/x-perl", "application/x-sh", "application/sql", "text/x-c", "text/x-c++", "text/x-csharp", "text/x-go", "text/x-haskell",
-        "text/x-lua", "text/x-markdown", "application/wasm", "application/x-tcl", "text/x-yaml", "application/x-latex", "application/x-tex", "text/x-scss", "application/x-lisp",
-        "application/x-rust", "application/x-ruby", "text/x-asm"
+        "text/html", "application/xhtml+xml", "application/xml", "text/css", "text/x-scss", "application/javascript", "text/javascript",
+        "application/json", "text/x-yaml", "text/x-markdown", "application/wasm", 
+        "text/x-ruby", "application/x-ruby", "text/x-perl", "application/x-lisp", 
+        "text/x-haskell", "text/x-lua", "application/x-tcl", 
+        "text/x-python", "text/x-java-source", "text/x-go", "application/x-rust", "text/x-asm", 
+        "application/sql", "text/x-c", "text/x-c++", "text/x-csharp", 
+        "application/x-httpd-php", "application/x-sh", "application/x-shellscript", 
+        "application/x-latex", "application/x-tex", 
     ].includes(mimeType)){
         return ICON_CODE;
     }

lfss/api/connector.py

@@ -114,7 +114,6 @@ class Connector:
         
         if isinstance(file, str):
             assert os.path.exists(file), "File does not exist on disk"
-            fsize = os.path.getsize(file)
 
         with open(file, 'rb') if isinstance(file, str) else SpooledTemporaryFile(max_size=1024*1024*32) as fp:
 
@@ -124,7 +123,6 @@ class Connector:
                 fp.seek(0)
 
             # https://stackoverflow.com/questions/12385179/
-            print(f"Uploading {fsize} bytes")
             response = self._fetch_factory('POST', path, search_params={
                 'permission': int(permission),
                 'conflict': conflict

lfss/cli/cli.py

@@ -1,6 +1,6 @@
-from lfss.api import Connector, upload_directory, upload_file, download_file, download_directory
 from pathlib import Path
 import argparse, typing
+from lfss.api import Connector, upload_directory, upload_file, download_file, download_directory
 from lfss.src.datatype import FileReadPermission, FileSortKey, DirSortKey
 from lfss.src.utils import decode_uri_compnents
 from . import catch_request_error, line_sep
@@ -18,7 +18,6 @@ def parse_permission(s: str) -> FileReadPermission:
 
 def parse_arguments():
     parser = argparse.ArgumentParser(description="Command line interface, please set LFSS_ENDPOINT and LFSS_TOKEN environment variables.")
-    parser.add_argument("-v", "--verbose", action="store_true", help="Verbose output")
 
     sp = parser.add_subparsers(dest="command", required=True)
 
@@ -26,6 +25,7 @@ def parse_arguments():
     sp_upload = sp.add_parser("upload", help="Upload files")
     sp_upload.add_argument("src", help="Source file or directory", type=str)
     sp_upload.add_argument("dst", help="Destination url path", type=str)
+    sp_upload.add_argument("-v", "--verbose", action="store_true", help="Verbose output")
     sp_upload.add_argument("-j", "--jobs", type=int, default=1, help="Number of concurrent uploads")
     sp_upload.add_argument("--interval", type=float, default=0, help="Interval between files, only works with directory upload")
     sp_upload.add_argument("--conflict", choices=["overwrite", "abort", "skip", "skip-ahead"], default="abort", help="Conflict resolution")
@@ -36,6 +36,7 @@ def parse_arguments():
     sp_download = sp.add_parser("download", help="Download files")
     sp_download.add_argument("src", help="Source url path", type=str)
     sp_download.add_argument("dst", help="Destination file or directory", type=str)
+    sp_download.add_argument("-v", "--verbose", action="store_true", help="Verbose output")
     sp_download.add_argument("-j", "--jobs", type=int, default=1, help="Number of concurrent downloads")
     sp_download.add_argument("--interval", type=float, default=0, help="Interval between files, only works with directory download")
     sp_download.add_argument("--overwrite", action="store_true", help="Overwrite existing files")

lfss/src/datatype.py

@@ -1,5 +1,6 @@
 from enum import IntEnum
 import dataclasses, typing
+from .utils import fmt_storage_size
 
 class FileReadPermission(IntEnum):
     UNSET = 0           # not set
@@ -18,8 +19,12 @@ class UserRecord:
     max_storage: int
     permission: 'FileReadPermission'
 
+    def __post_init__(self):
+        self.permission = FileReadPermission(self.permission)
+
     def __str__(self):
-        return f"User {self.username} (id={self.id}, admin={self.is_admin}, created at {self.create_time}, last active at {self.last_active}, storage={self.max_storage}, permission={self.permission})"
+        return  f"User {self.username} (id={self.id}, admin={self.is_admin}, created at {self.create_time}, last active at {self.last_active}, " + \
+                f"storage={fmt_storage_size(self.max_storage)}, permission={self.permission.name})"
 
 @dataclasses.dataclass
 class FileRecord:
@@ -33,9 +38,12 @@ class FileRecord:
     external: bool
     mime_type: str
 
+    def __post_init__(self):
+        self.permission = FileReadPermission(self.permission)
+
     def __str__(self):
         return  f"File {self.url} [{self.mime_type}] (owner={self.owner_id}, created at {self.create_time}, accessed at {self.access_time}, " + \
-                f"file_id={self.file_id}, permission={self.permission}, size={self.file_size}, external={self.external})"
+                f"file_id={self.file_id}, permission={self.permission.name}, size={fmt_storage_size(self.file_size)}, external={self.external})"
 
 @dataclasses.dataclass
 class DirectoryRecord:
@@ -47,7 +55,7 @@ class DirectoryRecord:
     n_files: int = -1
 
     def __str__(self):
-        return f"Directory {self.url} (size={self.size}, created at {self.create_time}, updated at {self.update_time}, accessed at {self.access_time}, n_files={self.n_files})"
+        return f"Directory {self.url} (size={fmt_storage_size(self.size)}, created at {self.create_time}, updated at {self.update_time}, accessed at {self.access_time}, n_files={self.n_files})"
 
 @dataclasses.dataclass
 class PathContents:

{lfss-0.8.3.dist-info → lfss-0.8.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lfss
-Version: 0.8.3
+Version: 0.8.4
 Summary: Lightweight file storage service
 Home-page: https://github.com/MenxLi/lfss
 Author: li, mengxun
@@ -24,9 +24,17 @@ Description-Content-Type: text/markdown
 # Lightweight File Storage Service (LFSS)
 [![PyPI](https://img.shields.io/pypi/v/lfss)](https://pypi.org/project/lfss/)
 
-My experiment on a lightweight and high-performance file/object storage service.  
+My experiment on a lightweight and high-performance file/object storage service...  
+
+**Highlights:**
+
+- User storage limit and access control.
+- Pagination and sorted file listing for vast number of files.  
+- High performance: high concurrency, near-native speed on stress tests.
+- Support range requests, so you can stream large files / resume download.
+
 It stores small files and metadata in sqlite, large files in the filesystem.  
-Tested on 2 million files, and it works fine... 
+Tested on 2 million files, and it is still fast.
 
 Usage: 
 ```sh
@@ -45,8 +53,8 @@ lfss-panel --open
 Or, you can start a web server at `/frontend` and open `index.html` in your browser. 
 
 The API usage is simple, just `GET`, `PUT`, `DELETE` to the `/<username>/file/url` path.  
-Authentication is done via `Authorization` header with the value `Bearer <token>`, or through the `token` query parameter.  
-You can refer to `frontend` as an application example, and `frontend/api.js` or `lfss/api/connector.py` for the API usage.
+Authentication via `Authorization` header with the value `Bearer <token>`, or through the `token` query parameter.  
+You can refer to `frontend` as an application example, `lfss/api/connector.py` for more APIs. 
 
 By default, the service exposes all files to the public for `GET` requests, 
 but file-listing is restricted to the user's own files.  

{lfss-0.8.3.dist-info → lfss-0.8.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-Readme.md,sha256=LpbTvUWjCOv4keMNDrZvEnNAmCQnvaxvlq2srWixXn0,1299
+Readme.md,sha256=J1tGk7B9EyIXT-RN7VGz_229UeKvZHVLpn1FvzNDxL4,1538
 docs/Known_issues.md,sha256=rfdG3j1OJF-59S9E06VPyn0nZKbW-ybPxkoZ7MEZWp8,81
 docs/Permission.md,sha256=9r9nEmhqfz18RTS8FI0fZ9F0a31r86OoAyx3EQxxpk0,2317
 frontend/api.js,sha256=wUJNAkL8QigAiwR_jaMPUhCQEsL-lp0wZ6XeueYgunE,18049
@@ -13,13 +13,13 @@ frontend/scripts.js,sha256=nWH6NgavZTVmjK44i2DeRi6mJzGSe4qeQPUbDaEVt58,21735
 frontend/state.js,sha256=vbNL5DProRKmSEY7xu9mZH6IY0PBenF8WGxPtGgDnLI,1680
 frontend/styles.css,sha256=xcNLqI3KBsY5TLnku8UIP0Jfr7QLajr1_KNlZj9eheM,4935
 frontend/thumb.css,sha256=rNsx766amYS2DajSQNabhpQ92gdTpNoQKmV69OKvtpI,295
-frontend/thumb.js,sha256=tX9LtxT6O2O6IUlpdvID6S973SUpWxgPVVqI9pwlVw8,6113
+frontend/thumb.js,sha256=46ViD2TlTTWy0fx6wjoAs_5CQ4ajYB90vVzM7UO2IHw,6182
 frontend/utils.js,sha256=IYUZl77ugiXKcLxSNOWC4NSS0CdD5yRgUsDb665j0xM,2556
 lfss/api/__init__.py,sha256=c_-GokKJ_3REgve16AwgXRfFyl9mwy7__FxCIIVlk1Q,6660
-lfss/api/connector.py,sha256=tCUwTlbzTwHvPnFb8nlnc6LEnrXwdCnCCThyBISt2Tg,11319
+lfss/api/connector.py,sha256=e2nhqrRGWixSJXRVDBxadq9oeiL0sGWLaL7FFzvLFJ8,11231
 lfss/cli/__init__.py,sha256=lPwPmqpa7EXQ4zlU7E7LOe6X2kw_xATGdwoHphUEirA,827
 lfss/cli/balance.py,sha256=R2rbO2tg9TVnnQIVeU0GJVeMS-5LDhEdk4mbOE9qGq0,4121
-lfss/cli/cli.py,sha256=LxUrviHtsqi-vs_GWZw2qRs9dBNvx9PSQHLW6SwUmhA,8167
+lfss/cli/cli.py,sha256=WVxDtIYCgFkEp9HoVLGi7AAhZJi5BCML7uT5D4yVcuE,8262
 lfss/cli/panel.py,sha256=iGdVmdWYjA_7a78ZzWEB_3ggIOBeUKTzg6F5zLaB25c,1401
 lfss/cli/serve.py,sha256=T-jz_PJcaY9FJRRfyWV9MbjDI73YdOOCn4Nr2PO-s0c,993
 lfss/cli/user.py,sha256=uqHQ7onddTjJAYg3B1DIc8hDl0aCkIMZolLKhQrBd0k,4046
@@ -31,14 +31,14 @@ lfss/src/bounded_pool.py,sha256=BI1dU-MBf82TMwJBYbjhEty7w1jIUKc5Bn9SnZ_-hoY,1288
 lfss/src/config.py,sha256=7k_6L_aG7vD-lVcmgpwMIg-ggpMMDNU8IbaB4y1effE,861
 lfss/src/connection_pool.py,sha256=4YULPcmndy33FyBSo9w1fZjAlBX2q-xPP27xJOTA06I,5228
 lfss/src/database.py,sha256=zoiBm7CVHHV4TqwmK6lPnZvK9mzDNtrNvAJCRaIYMU8,36302
-lfss/src/datatype.py,sha256=yyOcxhGwz-EJi003f8hGl82EJuY4F92y6fSX6cK60Bc,2126
+lfss/src/datatype.py,sha256=1xdxSKhpJXoBKumUokL3zQ2VyZ0Wwp8q6PaJf1idVw0,2435
 lfss/src/error.py,sha256=Bh_GUtuNsMSMIKbFreU4CfZzL96TZdNAIcgmDxvGbQ0,333
 lfss/src/log.py,sha256=u6WRZZsE7iOx6_CV2NHh1ugea26p408FI4WstZh896A,5139
 lfss/src/server.py,sha256=YLsp6bab7q0I2hI4uUYIiWc2S0k6d6bbMaweg6VbVV4,23743
 lfss/src/stat.py,sha256=WlRiiAl0rHX9oPi3thi6K4GKn70WHpClSDCt7iZUow4,3197
 lfss/src/thumb.py,sha256=qjCNMpnCozMuzkhm-2uAYy1eAuYTeWG6xqs-13HX-7k,3266
 lfss/src/utils.py,sha256=DxjHabdiISMkrm1WQlpsZFKL3by6YrzBNQaDt_uZlRk,5744
-lfss-0.8.3.dist-info/METADATA,sha256=2Q3LdTB3vX_i8kpXIJ9SmMv-GLC1kslzN0RUBW9ksSA,2059
-lfss-0.8.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-lfss-0.8.3.dist-info/entry_points.txt,sha256=VJ8svMz7RLtMCgNk99CElx7zo7M-N-z7BWDVw2HA92E,205
-lfss-0.8.3.dist-info/RECORD,,
+lfss-0.8.4.dist-info/METADATA,sha256=OUvtod8R5Z7DnNLczVG6FpsHEQ2J1ct8QlbdZhU2fIk,2298
+lfss-0.8.4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+lfss-0.8.4.dist-info/entry_points.txt,sha256=VJ8svMz7RLtMCgNk99CElx7zo7M-N-z7BWDVw2HA92E,205
+lfss-0.8.4.dist-info/RECORD,,