ipfs-node 0.1.6__py3-none-any.whl

ipfs_node-0.1.6.dist-info/METADATA

@@ -0,0 +1,134 @@
+Metadata-Version: 2.1
+Name: ipfs_node
+Version: 0.1.6
+Summary: Run an IPFS node inside of python using kubo as a library.
+Home-page: https://github.com/emendir/py_ipfs_node
+Author: Emendir
+Author-email: 
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cffi >=1.15.0
+
+# Kubo Python Library
+
+A Python wrapper for the Kubo (Go-IPFS) library.
+
+## Overview
+
+This library provides Python bindings for [Kubo](https://github.com/ipfs/kubo), the Go implementation of IPFS, allowing you to:
+
+- Spawn an in-process IPFS node
+- Add and retrieve files/directories from IPFS
+- Connect to the IPFS network
+- Manage IPFS repositories
+- Publish and subscribe to IPFS PubSub topics
+- Mount and connect to remote TCP services via libp2p
+
+## Project Status
+
+This library is very early in its development, and is published as a proof-of-concept that it is feasible to write a python wrapper around kubo (Go-IPFS) to run IPFS nodes from within python.
+Much of the code is LLM-generated, and code coverage is poor.
+
+The API structure of this library WILL CHANGE in the near future!
+
+So far this library has been tested on Linux x86 64-bit and Android ARM 64-bit (in Termux & in Kivy).
+Assuming that it proves to be a reliable way of working in python, this library will be developed to maturity and maintained.
+
+## Installation
+
+```bash
+pip install ipfs_node
+```
+
+## Dev Requirements
+
+- Go 1.19
+- Python 3.7+
+- IPFS Kubo dependencies
+
+## Basic Usage
+
+### Working with Files
+
+```python
+from ipfs_node import IpfsNode
+
+# Create a new node with a temporary repository
+with IpfsNode.ephemeral() as node:
+    # Add a file to IPFS
+    cid = node.files.publish("README.md")
+    print(f"Added file with CID: {cid}")
+    
+    # Retrieve a file from IPFS
+    node.files.download(cid, "download.md")
+```
+
+### Using PubSub
+
+```python
+from ipfs_node import IpfsNode
+
+with IpfsNode.ephemeral() as node:
+    # Subscribe to a topic
+    with node.pubsub.subscribe("my-topic") as subscription:
+        # Publish a message
+        node.pubsub.publish("my-topic", "Hello, IPFS world!")
+        
+        # Receive messages
+        message = subscription.next_message(timeout=2.0)
+        if message:
+            print(f"Received: {message.data.decode('utf-8')}")
+        
+        # Or use a callback
+        def on_message(msg):
+            print(f"Received via callback: {msg.data.decode('utf-8')}")
+        
+        subscription.subscribe(on_message)
+```
+
+### Using TCP Tunnels (LibP2P Stream Mounting)
+
+```python
+from ipfs_node import IpfsNode
+
+# Create an IPFS node
+with IpfsNode.ephemeral() as node:
+    
+    # Example 1: Listen for connections on a protocol and forward them to a local service
+    node.tunnels.open_listener("my-service", 8888)
+    
+    # Example 2: Forward local connections to a remote peer
+    node.tunnels.open_sender("their-service", 8889, node.peer_id)
+    
+    # List active listeners and streams
+    tunnels = node.tunnels.get_tunnels()
+    print(tunnels.listeners)
+    print(tunnels.senders)
+    
+    # Close specific connections when done
+    node.tunnels.close_listener("my-service")
+    node.tunnels.close_sender("their-service")
+```
+
+## Documentation
+
+- [Installation Instructions](INSTALL.md)
+- [PubSub Documentation](docs/pubsub.md)
+- [P2P Stream Mounting](docs/p2p.md)
+
+## Examples
+
+- [Basic Usage](examples/basic_usage.py)
+- [File Sharing](examples/file_sharing.py)
+- [PubSub Example](examples/pubsub_example.py)
+- [Chat Application](examples/chat_app.py)
+- [P2P Stream Mounting](examples/p2p_example.py)
+- [P2P Socket Communication](examples/p2p_socket_example.py)
+
+## License
+
+MIT License

ipfs_node-0.1.6.dist-info/RECORD

@@ -0,0 +1,18 @@
+ipfs_node/__init__.py,sha256=hYyXSpnmMQLeaX2ssUVZl5ghbiVp-W2Ri_Dbdu9e1Jo,197
+ipfs_node/ipfs_files.py,sha256=uM2u74VBRWwGGlSJNq_3A4_bYb7RdfIHXP5YVDDL43I,7985
+ipfs_node/ipfs_node.py,sha256=E88bXvUjycwlPXAAa2pvRpQCANHGSFBWx9GQTIxRqsg,7287
+ipfs_node/ipfs_peers.py,sha256=yp56fI9OpyzGg8JHt9o89lT2nWI4YpzMrRvUfETlPZc,2216
+ipfs_node/ipfs_pubsub.py,sha256=g3mSV45BonYXZASgtWVGsi3VVSkZmOkBRldSRys6mlI,14439
+ipfs_node/ipfs_tunnels.py,sha256=__681B9UzHXi7r1CP32uVEeMYlV8-O4JPc6yUKZwQ4M,9018
+ipfs_node/libkubo/libkubo_linux_x86_64.h,sha256=OVfQ74CEPn8M6nDWkDQluwDgSeRJOV0wOyBAvBMGJqM,5743
+ipfs_node/libkubo/libkubo_linux_x86_64.so,sha256=JTnr5s0vdrUTYWQNKiUSR6fGXjtRH7wKaQygiCqSwQI,82524080
+ipfs_node/utils/__init__.py,sha256=gskzZJEh_l3vsWbpgQII732lYNfqA835YXvMlxKiDkA,91
+ipfs_node/utils/cid_utils.py,sha256=K5g8VIueJDS0zsbkJV8ZccFa6rdOA9ShwsYJlyX-REU,1457
+ipfs_node/utils/peer_utils.py,sha256=ynZKbg2L26r0DfRUNYcVQQP_eguK6xENTFUhxHpHGmE,1848
+libkubo/__init__.py,sha256=vg0PGjCRNyMadI3bRYtTjfxoaA6XMO7klgZuR2vQ2nU,67
+libkubo/libkubo_loader.py,sha256=a691BPSD_VRC8AdFCB7ihKEypDXrmtMXtpC5gjTxljM,1257
+ipfs_node-0.1.6.dist-info/LICENSE,sha256=O-0zMbcEi6wXz1DiSdVgzMlQjJcNqNe5KDv08uYzqR0,1055
+ipfs_node-0.1.6.dist-info/METADATA,sha256=gnaQYxi9bMy5FTa_5p1TziulfQjR0fuQG7tRrC2Cuo4,3784
+ipfs_node-0.1.6.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+ipfs_node-0.1.6.dist-info/top_level.txt,sha256=JqYMx6doRQgowycGRhKqc0zfikahqizuG9128CZcF3Y,18
+ipfs_node-0.1.6.dist-info/RECORD,,

ipfs_node-0.1.6.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (72.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ipfs_node-0.1.6.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+ipfs_node
+libkubo

libkubo/__init__.py

@@ -0,0 +1 @@
+from .libkubo_loader import libkubo, c_str, from_c_str, ffi, c_bool

libkubo/libkubo_loader.py

@@ -0,0 +1,45 @@
+from cffi import FFI
+import platform
+from pathlib import Path
+ffi = FFI()
+
+
+# Determine library name based on platform
+if platform.system() == 'Windows':
+    lib_name = 'libkubo.dll'
+    header_name = 'libkubo.h'
+elif platform.system() == 'Darwin':
+    lib_name = 'libkubo.dylib'
+    header_name = 'libkubo.h'
+else:
+    if "aarch64" == platform.machine():
+        lib_name = "libkubo_android_arm64.so"
+        header_name = "libkubo_android_arm64.h"
+    else:
+        lib_name = 'libkubo_linux_x86_64.so'
+        header_name = 'libkubo_linux_x86_64.h'
+
+
+
+# Get the absolute path to the library
+lib_path = str(Path(__file__).parent / lib_name)
+header_path = str(Path(__file__).parent / header_name)
+
+with open(header_path) as file:
+    lines = [line.strip() for line in file.readlines()]
+func_declarations = [
+    line for line in lines if line.startswith("extern ") and line.endswith(";")
+]
+ffi.cdef("\n".join(func_declarations))
+ffi.set_source("libkubo", None)
+libkubo = ffi.dlopen(lib_path)
+
+
+def c_str(data:str|bytes):
+    if isinstance(data, str):
+        data = data.encode()
+    return ffi.new("char[]", data)
+def from_c_str(string_ptr):
+    return ffi.string(string_ptr).decode('utf-8')
+def c_bool(value: bool):
+    return ffi.new("bool *", value)[0]