hippius 0.1.10__tar.gz → 0.1.12__tar.gz

{hippius-0.1.10 → hippius-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hippius
-Version: 0.1.10
+Version: 0.1.12
 Summary: Python SDK and CLI for Hippius blockchain storage
 Home-page: https://github.com/thenervelab/hippius-sdk
 Author: Dubs
@@ -46,6 +46,10 @@ A Python SDK and CLI for interacting with Hippius blockchain storage, designed s
 ## Installation
 
 ```bash
+
+# Using pipx
+pipx install hippius
+
 # Using pip
 pip install hippius
 
@@ -348,12 +352,63 @@ When choosing the second option, the system will process each file in the direct
 - Successfully coded files with their metadata CIDs
 - Any files that failed, with error details
 
+You can also directly use the dedicated command for directory erasure coding:
+
+```bash
+# Direct command for applying erasure coding to an entire directory
+hippius erasure-code-dir my_directory/
+
+# With custom parameters
+hippius erasure-code-dir my_important_files/ --k 4 --m 8 --encrypt
+```
+
+This dedicated command processes each file in the directory individually, optimizing erasure coding parameters for each file based on its size.
+
+**Important Note on Directory Structure:**
+- The command processes all files in the entire directory hierarchy, including all subdirectories
+- Each file is processed independently and gets its own separate metadata CID
+- The original directory structure is not automatically preserved for reconstruction
+- You will need to reconstruct each file individually using its specific metadata CID
+
+If preserving the exact directory structure is important, consider these options:
+1. Archive the directory first (option 1 above), then erasure code the single archive file
+2. Keep track of the original file paths relative to the root directory in your own system
+3. For small directories with few files, reconstruct each file individually and manually recreate the structure
+
 To reconstruct a file from erasure-coded chunks:
 
 ```bash
 hippius reconstruct QmMetadataCID reconstructed_filename
 ```
 
+**Integration with Other Features:**
+The directory erasure coding functionality works seamlessly with other Hippius SDK features:
+
+- **Account Management**: Use with multiple coldkeys and hotkeys by specifying the account with `--account` 
+- **Default Address**: Combined with default address management for streamlined operations
+- **Proxy Support**: Hotkeys with proper permissions can perform erasure coding operations on behalf of a coldkey
+- **Configuration Management**: All erasure coding parameters can be preset in your config file with `hippius config set`
+
+For a comprehensive workflow, you can manage accounts, set default addresses, configure erasure coding parameters, and then process directories in a single sequence of commands:
+
+```bash
+# Set active account
+hippius account switch my_account_name
+
+# Set default address for operations
+hippius address set-default 5H1QBRF7T7dgKwzVGCgS4wioudvMRf9K4NEDzfuKLnuyBNzH
+
+# Configure default erasure coding parameters
+hippius config set erasure_coding default_k 4
+hippius config set erasure_coding default_m 8
+
+# Apply erasure coding to a directory
+hippius erasure-code-dir my_important_directory/
+
+# Check the status of erasure-coded files
+hippius ec-files
+```
+
 #### Default Address Management
 
 Hippius SDK now allows setting a default address for read-only operations, making it easier to use commands like `files` and `ec-files` without specifying an account address each time:

{hippius-0.1.10 → hippius-0.1.12}/README.md

@@ -15,6 +15,10 @@ A Python SDK and CLI for interacting with Hippius blockchain storage, designed s
 ## Installation
 
 ```bash
+
+# Using pipx
+pipx install hippius
+
 # Using pip
 pip install hippius
 
@@ -317,12 +321,63 @@ When choosing the second option, the system will process each file in the direct
 - Successfully coded files with their metadata CIDs
 - Any files that failed, with error details
 
+You can also directly use the dedicated command for directory erasure coding:
+
+```bash
+# Direct command for applying erasure coding to an entire directory
+hippius erasure-code-dir my_directory/
+
+# With custom parameters
+hippius erasure-code-dir my_important_files/ --k 4 --m 8 --encrypt
+```
+
+This dedicated command processes each file in the directory individually, optimizing erasure coding parameters for each file based on its size.
+
+**Important Note on Directory Structure:**
+- The command processes all files in the entire directory hierarchy, including all subdirectories
+- Each file is processed independently and gets its own separate metadata CID
+- The original directory structure is not automatically preserved for reconstruction
+- You will need to reconstruct each file individually using its specific metadata CID
+
+If preserving the exact directory structure is important, consider these options:
+1. Archive the directory first (option 1 above), then erasure code the single archive file
+2. Keep track of the original file paths relative to the root directory in your own system
+3. For small directories with few files, reconstruct each file individually and manually recreate the structure
+
 To reconstruct a file from erasure-coded chunks:
 
 ```bash
 hippius reconstruct QmMetadataCID reconstructed_filename
 ```
 
+**Integration with Other Features:**
+The directory erasure coding functionality works seamlessly with other Hippius SDK features:
+
+- **Account Management**: Use with multiple coldkeys and hotkeys by specifying the account with `--account` 
+- **Default Address**: Combined with default address management for streamlined operations
+- **Proxy Support**: Hotkeys with proper permissions can perform erasure coding operations on behalf of a coldkey
+- **Configuration Management**: All erasure coding parameters can be preset in your config file with `hippius config set`
+
+For a comprehensive workflow, you can manage accounts, set default addresses, configure erasure coding parameters, and then process directories in a single sequence of commands:
+
+```bash
+# Set active account
+hippius account switch my_account_name
+
+# Set default address for operations
+hippius address set-default 5H1QBRF7T7dgKwzVGCgS4wioudvMRf9K4NEDzfuKLnuyBNzH
+
+# Configure default erasure coding parameters
+hippius config set erasure_coding default_k 4
+hippius config set erasure_coding default_m 8
+
+# Apply erasure coding to a directory
+hippius erasure-code-dir my_important_directory/
+
+# Check the status of erasure-coded files
+hippius ec-files
+```
+
 #### Default Address Management
 
 Hippius SDK now allows setting a default address for read-only operations, making it easier to use commands like `files` and `ec-files` without specifying an account address each time:

{hippius-0.1.10 → hippius-0.1.12}/hippius_sdk/cli.py

@@ -1915,6 +1915,41 @@ examples:
         "--verbose", action="store_true", help="Enable verbose output", default=True
     )
 
+    # Erasure code directory command
+    erasure_code_dir_parser = subparsers.add_parser(
+        "erasure-code-dir", help="Apply erasure coding to each file in a directory"
+    )
+    erasure_code_dir_parser.add_argument(
+        "dir_path", help="Path to directory to process"
+    )
+    erasure_code_dir_parser.add_argument(
+        "--k",
+        type=int,
+        default=3,
+        help="Number of data chunks needed to reconstruct (default: 3)",
+    )
+    erasure_code_dir_parser.add_argument(
+        "--m", type=int, default=5, help="Total number of chunks to create (default: 5)"
+    )
+    erasure_code_dir_parser.add_argument(
+        "--chunk-size",
+        type=int,
+        default=1048576,
+        help="Chunk size in bytes (default: 1MB)",
+    )
+    erasure_code_dir_parser.add_argument(
+        "--miner-ids", help="Comma-separated list of miner IDs"
+    )
+    erasure_code_dir_parser.add_argument(
+        "--encrypt", action="store_true", help="Encrypt the files"
+    )
+    erasure_code_dir_parser.add_argument(
+        "--no-encrypt", action="store_true", help="Do not encrypt the files"
+    )
+    erasure_code_dir_parser.add_argument(
+        "--verbose", action="store_true", help="Enable verbose output", default=True
+    )
+
     # Reconstruct command
     reconstruct_parser = subparsers.add_parser(
         "reconstruct", help="Reconstruct an erasure-coded file"
@@ -2260,6 +2295,18 @@ examples:
                 verbose=args.verbose,
             )
 
+        elif args.command == "erasure-code-dir":
+            return handle_erasure_code_directory(
+                client,
+                args.dir_path,
+                args.k,
+                args.m,
+                args.chunk_size,
+                miner_ids,
+                encrypt=args.encrypt,
+                verbose=args.verbose,
+            )
+
         elif args.command == "reconstruct":
             return handle_reconstruct(
                 client, args.metadata_cid, args.output_file, verbose=args.verbose

{hippius-0.1.10 → hippius-0.1.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hippius"
-version = "0.1.10"
+version = "0.1.12"
 description = "Python SDK and CLI for Hippius blockchain storage"
 authors = ["Dubs <dubs@dubs.rs>"]
 readme = "README.md"