Major Updates

* Test updates
* Add index option to get_all_snapshots()
* find_snapshots - Removing check for path existing in current FS
* get_diffs():
    * Add checks for stdout / stderr and return code
* Remove Python2 supports
* add name_full property to snapshot

Author: JavaScriptDude

LICENSE

@@ -1 +1,21 @@
-TBD
+MIT License
+
+Copyright (c) 2022 Timothy C. Quinn <javascriptdude [at] protonmail.com>
+
+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.

README.md

@@ -4,7 +4,7 @@ ZFS Libraries for Python
 
 Python library for reading from ZFS Pools. Capable of reading, Pools, Datasets, Snapshots and Diffs for use by other Python Tools.
 
-This tool presently targets Python v3.7+ but will be backported if there is desire from the community and after the APIs have been stablized.
+This tool presently targets Python v3.7+ but has been tested for Python 2.7.18 but Python 2.x support my be removed with future releases.
 
 ## Installation
 

dev.env

@@ -0,0 +1 @@
+PYTHONPATH=./src:${PYTHONPATH}

examples/ex_remote.py

@@ -25,33 +25,35 @@ def main(argv):
 
 
     # Get first snapshot in specific pool/dataset
-    p = poolset.get_pool('freenas-boot')
-    ds = p.get_dataset('ROOT/11.3-U5')
+    p = poolset.get_pool('tank')
+    ds = p.get_dataset('.system/samba4')
     all_snaps = ds.get_all_snapshots()
     if len(all_snaps) == 0:
         print('No snapshots found for dataset: {}'.format(ds))
+
     else:
-        print('First Snapshot for dataset {}: {}'.format(ds, all_snaps[0]))
+        snap = all_snaps[0]
+        
+        print('First Snapshot for dataset {}: {}'.format(ds, snap))
 
 
-    if False:
-        # Lookup snapshot by its name within poolset
-        snap = poolset.lookup('freenas-boot/ROOT/11.3-U5@2020-01-30-19:49:13')
-        print('poolset.lookup snap: {}'.format(snap))
+        if True:
+            # Lookup snapshot by its name within poolset
+            snap = poolset.lookup(snap.path)
+            print('poolset.lookup snap: {}'.format(snap))
 
 
-    if False:
-        # Lookup snapshot by its name within pool
-        p = poolset.get_pool('freenas-boot')
-        snap = p.lookup('ROOT/11.3-U5@2020-01-30-19:49:13')
-        print('pool.lookup snap: {}'.format(snap))
+        if True:
+            # Lookup snapshot by its name within pool
+            snap = p.lookup(snap.name_full)
+            print('pool.lookup snap: {}'.format(snap))
 
 
-    # Iterate through all pools and print all datasets
-    if False:
-        print("Pools and Datasets:")
-        for p in poolset:
-            print_all_datasets(p)
+        # Iterate through all pools and print all datasets
+        if True:
+            print("Pools and Datasets:")
+            for p in poolset:
+                print_all_datasets(p)
 
 
 

pyproject.toml

@@ -0,0 +1,34 @@
+[tool.poetry]
+name = "zfslib"
+version = "0.9.1"
+description = "ZFS Utilities For Python3"
+license = "MIT"
+authors = ["Timothy C. Quinn"]
+readme = "README.md"
+homepage = "https://pypi.org/project/zfslib"
+repository = "https://github.com/JavaScriptDude/zfslib"
+classifiers = [
+    'Development Status :: 4 - Beta',
+    'Environment :: Console',
+    'Intended Audience :: System Administrators',
+    'License :: OSI Approved :: BSD License',
+    'Operating System :: POSIX :: Linux',
+    'Operating System :: POSIX :: BSD',
+    'Operating System :: POSIX :: SunOS/Solaris',
+    'Operating System :: MacOS :: MacOS X',
+    'Programming Language :: Python :: 3 :: Only',
+    'Programming Language :: Python :: 3.7',
+    'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.9',
+    'Topic :: System :: Filesystems',
+    'Topic :: Utilities',
+]
+
+[tool.poetry.dependencies]
+python = "^3.7.9"
+
+[tool.poetry.dev-dependencies]
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

requirements.txt

@@ -0,0 +1 @@
+pathlib2

src/zfslib/__init__.py

@@ -0,0 +1 @@
+from .zfslib import *