sshfs-offline 0.0.1__tar.gz

sshfs_offline-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 David Christenson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sshfs_offline-0.0.1/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: sshfs-offline
+Version: 0.0.1
+Summary: SSH File System with offline access to cached files.
+Author-email: Dave Christenson <davechri58@gmail.com>
+License: MIT
+Keywords: offline,cache,sshfs,fuse-filesystem,fuse
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: System :: Filesystems
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: License :: OSI Approved :: MIT License
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+sshfs-offline
+=============
+
+SSH File System with offline access to cached files.
+
+Features:
+
+  - Based on FUSE (Filesystem in Userspace framework for Linux)
+
+  - Metadata and Data are cached locally to improve performance.
+
+  - Offline access to cached data when the remote host is not reachable
+
+  - Read/Write file system
+
+Install Script:
+===============
+
+```sh
+$ pip install sshfs-offline
+
+```
+
+How to mount a filesystem
+=========================
+
+Usage:
+
+    ```sh
+    usage: sshfs-offline [-h] [-p PORT] [-u USER] [-d REMOTEDIR] [--debug] [--cachetimeout CACHETIMEOUT] host mountpoint
+
+    To unmount use: fusermount -u mountpoint
+
+    positional arguments:
+      host                  remote host name
+      mountpoint            local mount point (eg, ~/mnt)
+
+    options:
+      -h, --help            show this help message and exit
+      -p PORT, --port PORT  port number (default=22)
+      -u USER, --user USER  user on remote host
+      -d REMOTEDIR, --remotedir REMOTEDIR
+                            directory on remote host (eg, ~/)
+      --debug               run in debug mode
+      --cachetimeout CACHETIMEOUT
+                            duration in seconds to keep metadata cached (default is 5 minutes)
+
+    ```
+
+Example:
+
+    ```sh
+    sshfs-offline localhost ~/mnt
+    ```
+
+Note, that it's recommended to run it as user, not as root.  For this
+to work the mountpoint must be owned by the user.  If the username is
+different on the host you are connecting to, then use the --user option.
+
+If you need to enter a password sshfs-offline will ask for it. 
+You can also specify a remote directory using --remotedir.  The default
+is your home directory.
+
+The cache timeout defaults to 5 minutes, and can be set with the -cachetimeout option.
+
+To unmount the filesystem:
+
+    fusermount -u mountpoint
+
+Cache Implementation
+====================
+
+The data and metadata are cached in the **.sshfs-offline** directory.  In this example, the **test/myfile.txt** file has two 132K blocks.  The data is cached in the **data** sub-directory, and the metadata is cached in the **metadata** sub-directory.
+
+```sh
+➜  .sshfs-offline
+├── data
+│   └── localhost   # host name
+│       └── home
+│           └── dave
+│               └── test
+│                   └── myfile.txt 
+└── metadata
+    └── localhost   # host name
+        └── home
+            └── user                
+                ├── %test        # test direcotry
+                │   ├── getattr  # lstat status for directory
+                │   └── readdir  # directory entries
+                └── %test%myfile.txt  # test/myfile.txt file
+                    ├── blockmap      # track blocks that are cached
+                    └── getattr       # lstat status for file 
+```
+
+Debugging
+=========
+
+* Metrics are logged to the **~/.sshfs-offline/metrics.log** file.
+* In production  (--debug=False), the log level is set to **warning**, and logs are writtend to the **~/.sshfs-offline/error.log** file.
+* If the --debug option is specified, the log level is set to **debug**, the process is run in the foreground, and logs are written to stdout.
+
+Using the tail command to follow the metrics:
+```sh
+$ tail -f ~/.sshfs-offline
+2025-09-23 07:26:19,237:INFO:metrics 
+   getattr         : 181
+   getattr_hit     : 181
+   init            : 1
+   readdir         : 26
+   readdir_hit     : 26
+   readlink        : 104
+   readlink_hit    : 104
+   sftp_chdir      : 1
+   sftp_connected  : 1
+   sftp_healthThread: 1
+   sftp_start      : 1
+```
+
+Development
+===========
+
+Create Virtual Environment:
+
+```sh
+$ python3 -m venv my-venv-name
+$ source ~/my-venv-name/bin/activate
+$ pip install -r requirements.txt
+```
+
+Mount filesystem:
+
+```sh
+$ ./sshfs-offline/cli.py localhost ~/mnt
+
+```
+

sshfs_offline-0.0.1/README.md

@@ -0,0 +1,136 @@
+sshfs-offline
+=============
+
+SSH File System with offline access to cached files.
+
+Features:
+
+  - Based on FUSE (Filesystem in Userspace framework for Linux)
+
+  - Metadata and Data are cached locally to improve performance.
+
+  - Offline access to cached data when the remote host is not reachable
+
+  - Read/Write file system
+
+Install Script:
+===============
+
+```sh
+$ pip install sshfs-offline
+
+```
+
+How to mount a filesystem
+=========================
+
+Usage:
+
+    ```sh
+    usage: sshfs-offline [-h] [-p PORT] [-u USER] [-d REMOTEDIR] [--debug] [--cachetimeout CACHETIMEOUT] host mountpoint
+
+    To unmount use: fusermount -u mountpoint
+
+    positional arguments:
+      host                  remote host name
+      mountpoint            local mount point (eg, ~/mnt)
+
+    options:
+      -h, --help            show this help message and exit
+      -p PORT, --port PORT  port number (default=22)
+      -u USER, --user USER  user on remote host
+      -d REMOTEDIR, --remotedir REMOTEDIR
+                            directory on remote host (eg, ~/)
+      --debug               run in debug mode
+      --cachetimeout CACHETIMEOUT
+                            duration in seconds to keep metadata cached (default is 5 minutes)
+
+    ```
+
+Example:
+
+    ```sh
+    sshfs-offline localhost ~/mnt
+    ```
+
+Note, that it's recommended to run it as user, not as root.  For this
+to work the mountpoint must be owned by the user.  If the username is
+different on the host you are connecting to, then use the --user option.
+
+If you need to enter a password sshfs-offline will ask for it. 
+You can also specify a remote directory using --remotedir.  The default
+is your home directory.
+
+The cache timeout defaults to 5 minutes, and can be set with the -cachetimeout option.
+
+To unmount the filesystem:
+
+    fusermount -u mountpoint
+
+Cache Implementation
+====================
+
+The data and metadata are cached in the **.sshfs-offline** directory.  In this example, the **test/myfile.txt** file has two 132K blocks.  The data is cached in the **data** sub-directory, and the metadata is cached in the **metadata** sub-directory.
+
+```sh
+➜  .sshfs-offline
+├── data
+│   └── localhost   # host name
+│       └── home
+│           └── dave
+│               └── test
+│                   └── myfile.txt 
+└── metadata
+    └── localhost   # host name
+        └── home
+            └── user                
+                ├── %test        # test direcotry
+                │   ├── getattr  # lstat status for directory
+                │   └── readdir  # directory entries
+                └── %test%myfile.txt  # test/myfile.txt file
+                    ├── blockmap      # track blocks that are cached
+                    └── getattr       # lstat status for file 
+```
+
+Debugging
+=========
+
+* Metrics are logged to the **~/.sshfs-offline/metrics.log** file.
+* In production  (--debug=False), the log level is set to **warning**, and logs are writtend to the **~/.sshfs-offline/error.log** file.
+* If the --debug option is specified, the log level is set to **debug**, the process is run in the foreground, and logs are written to stdout.
+
+Using the tail command to follow the metrics:
+```sh
+$ tail -f ~/.sshfs-offline
+2025-09-23 07:26:19,237:INFO:metrics 
+   getattr         : 181
+   getattr_hit     : 181
+   init            : 1
+   readdir         : 26
+   readdir_hit     : 26
+   readlink        : 104
+   readlink_hit    : 104
+   sftp_chdir      : 1
+   sftp_connected  : 1
+   sftp_healthThread: 1
+   sftp_start      : 1
+```
+
+Development
+===========
+
+Create Virtual Environment:
+
+```sh
+$ python3 -m venv my-venv-name
+$ source ~/my-venv-name/bin/activate
+$ pip install -r requirements.txt
+```
+
+Mount filesystem:
+
+```sh
+$ ./sshfs-offline/cli.py localhost ~/mnt
+
+```
+

sshfs_offline-0.0.1/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt", "requirements-swh.txt"]}
+
+[project]
+name = "sshfs-offline"
+version = "0.0.1"
+license = { text = "MIT" }
+authors = [
+    { name="Dave Christenson", email="davechri58@gmail.com" }
+]
+description = "SSH File System with offline access to cached files."
+readme = "README.md"
+keywords = ["offline", "cache", "sshfs", "fuse-filesystem", "fuse"]
+classifiers = [
+  # How mature is this project? Common values are
+  #   3 - Alpha
+  #   4 - Beta
+  #   5 - Production/Stable
+  "Development Status :: 4 - Beta",
+
+  # Indicate who your project is intended for
+  "Topic :: System :: Filesystems",
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Intended Audience :: End Users/Desktop",
+  "Operating System :: MacOS :: MacOS X",
+  "Operating System :: POSIX :: Linux",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 2.7",
+  "Programming Language :: Python :: 3.3",
+  "Programming Language :: Python :: 3.4",
+  "Programming Language :: Python :: 3.5",
+  "Programming Language :: Python :: Implementation :: PyPy",
+  "License :: OSI Approved :: MIT License",  
+]
+
+[project.scripts]
+sshfs-offline = "sshfs_offline.cli:main"

sshfs_offline-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+