ipfs-node 0.1.12rc2__py3-none-android_28_arm64_v8a.whl

ipfs_node-0.1.12rc2.dist-info/METADATA

@@ -0,0 +1,194 @@
+Metadata-Version: 2.1
+Name: ipfs_node
+Version: 0.1.12rc2
+Summary: Run an IPFS node inside of python using kubo as a library.
+Author: Emendir
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/emendir/py_ipfs_node
+Project-URL: Repository, https://github.com/emendir/py_ipfs_node
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE-CC0
+Dynamic: license-file
+Requires-Dist: cffi >=1.15.0
+Requires-Dist: ipfs-tk
+
+# 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 **EXPERIMENTAL**
+
+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 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.
+
+## Compatibility
+
+- linux x86-64 (tested on Ubuntu)
+- linux arm-64 (tested on Ubuntu on a raspberry pi 5)
+
+## Roadmap
+
+[py_ipfs_node](https://github.com/emendir/py_ipfs_node), will be incorporated into [ipfs_toolkit](https://github.com/emendir/IPFS-Toolkit-Python) [when py_ipfs_node's API has stabilised](https://github.com/emendir/py_ipfs_node/issues/1).
+
+[ipfs_toolkit](https://github.com/emendir/IPFS-Toolkit-Python) will become a multimodal IPFS library with a unified API for alternative modes of using IPFS:
+- running an embedded IPFS node
+- interacting with a separate IPFS node via its HTTP RPC
+
+You can check out a prototype version of the combination of these two libraries under the `kubo_python` branch of the IPFS-Toolkit repo:
+https://github.com/emendir/IPFS-Toolkit-Python/tree/kubo_python
+
+## 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)
+
+## Contributing
+
+### Get Involved
+
+- GitHub Discussions: if you want to share ideas
+- GitHub Issues: if you find bugs, other issues, or would like to submit feature requests
+- GitHub Merge Requests: if you think you know what you're doing, you're very welcome!
+
+### Donations
+
+To support me in my work on this and other projects, you can make donations with the following currencies:
+
+- **Bitcoin:** `BC1Q45QEE6YTNGRC5TSZ42ZL3MWV8798ZEF70H2DG0`
+- **Ethereum:** `0xA32C3bBC2106C986317f202B3aa8eBc3063323D4`
+- [**Fiat** (via Credit or Debit Card, Apple Pay, Google Pay, Revolut Pay)](https://checkout.revolut.com/pay/4e4d24de-26cf-4e7d-9e84-ede89ec67f32)
+
+Donations help me:
+- dedicate more time to developing and maintaining open-source projects
+- cover costs for IT infrastructure
+- finance projects requiring additional hardware & compute
+
+## About the Developer
+
+This project is developed by a human one-man team, publishing under the name _Emendir_.  
+I build open technologies trying to improve our world;
+learning, working and sharing under the principle:
+
+> _Freely I have received, freely I give._
+
+Feel welcome to join in with code contributions, discussions, ideas and more!
+
+## Open-Source in the Public Domain
+
+I dedicate this project to the public domain.
+It is open source and free to use, share, modify, and build upon without restrictions or conditions.
+
+I make no patent or trademark claims over this project.  
+
+Formally, you may use this project under either the: 
+- [MIT No Attribution (MIT-0)](https://choosealicense.com/licenses/mit-0/) or
+- [Creative Commons Zero (CC0)](https://choosealicense.com/licenses/cc0-1.0/)
+licence at your choice.  
+
+

ipfs_node-0.1.12rc2.dist-info/RECORD

@@ -0,0 +1,19 @@
+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/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_android_28_arm64_v8a.h,sha256=h0wwA61bl-7youyYsLcCI_0dMiGzEFv0ato8j-x45uQ,5731
+libkubo/libkubo_android_28_arm64_v8a.so,sha256=fXK8ghw9gncfp5ZDleqGj65T-afYFduuTmhUlUcHvX4,86189592
+libkubo/libkubo_loader.py,sha256=kw1JoXpUxVRdtuhV9XqokSlzN2eiPA-7mzKqjX96lUE,2681
+ipfs_node-0.1.12rc2.dist-info/LICENSE,sha256=i720OgyQLs68DSskm7ZLzaGKMnfskBIIHOuPWfwT2q4,907
+ipfs_node-0.1.12rc2.dist-info/LICENSE-CC0,sha256=kXBMw0w0VVXQAbLjqMKmis4OngrPaK4HY9ScH6MdtxM,7038
+ipfs_node-0.1.12rc2.dist-info/METADATA,sha256=R2Y_uF5hOjHVr5-wR-Q3ibV2_T3FKo6YIw4k0zNd76Q,6351
+ipfs_node-0.1.12rc2.dist-info/WHEEL,sha256=KwHuuB9H22nvIAOyiKztrgMM-QBniZGqMjE6jssEJEA,110
+ipfs_node-0.1.12rc2.dist-info/top_level.txt,sha256=JqYMx6doRQgowycGRhKqc0zfikahqizuG9128CZcF3Y,18
+ipfs_node-0.1.12rc2.dist-info/RECORD,,

ipfs_node-0.1.12rc2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: false
+Tag: py3-none-android_28_arm64_v8a
+

ipfs_node-0.1.12rc2.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_android_28_arm64_v8a.h

@@ -0,0 +1,237 @@
+/* Code generated by cmd/cgo; DO NOT EDIT. */
+
+/* package github.com/emendir/py_ipfs_node/libkubo */
+
+
+#line 1 "cgo-builtin-export-prolog"
+
+#include <stddef.h>
+
+#ifndef GO_CGO_EXPORT_PROLOGUE_H
+#define GO_CGO_EXPORT_PROLOGUE_H
+
+#ifndef GO_CGO_GOSTRING_TYPEDEF
+typedef struct { const char *p; ptrdiff_t n; } _GoString_;
+#endif
+
+#endif
+
+/* Start of preamble from import "C" comments.  */
+
+
+#line 3 "files.go"
+ #include <stdlib.h>
+ #include <stdbool.h>
+
+#line 1 "cgo-generated-wrapper"
+
+#line 3 "p2p.go"
+
+#include <stdlib.h>
+#include <stdbool.h>
+
+#line 1 "cgo-generated-wrapper"
+
+#line 3 "peers.go"
+ #include <stdlib.h>
+
+#line 1 "cgo-generated-wrapper"
+
+#line 3 "pubsub.go"
+ #include <stdlib.h>
+
+#line 1 "cgo-generated-wrapper"
+
+#line 3 "repo.go"
+ #include <stdlib.h>
+
+#line 1 "cgo-generated-wrapper"
+
+
+/* End of preamble from import "C" comments.  */
+
+
+/* Start of boilerplate cgo prologue.  */
+#line 1 "cgo-gcc-export-header-prolog"
+
+#ifndef GO_CGO_PROLOGUE_H
+#define GO_CGO_PROLOGUE_H
+
+typedef signed char GoInt8;
+typedef unsigned char GoUint8;
+typedef short GoInt16;
+typedef unsigned short GoUint16;
+typedef int GoInt32;
+typedef unsigned int GoUint32;
+typedef long long GoInt64;
+typedef unsigned long long GoUint64;
+typedef GoInt64 GoInt;
+typedef GoUint64 GoUint;
+typedef size_t GoUintptr;
+typedef float GoFloat32;
+typedef double GoFloat64;
+#ifdef _MSC_VER
+#include <complex.h>
+typedef _Fcomplex GoComplex64;
+typedef _Dcomplex GoComplex128;
+#else
+typedef float _Complex GoComplex64;
+typedef double _Complex GoComplex128;
+#endif
+
+/*
+  static assertion to make sure the file is being used on architecture
+  at least with matching size of GoInt.
+*/
+typedef char _check_for_64_bit_pointer_matching_GoInt[sizeof(void*)==64/8 ? 1:-1];
+
+#ifndef GO_CGO_GOSTRING_TYPEDEF
+typedef _GoString_ GoString;
+#endif
+typedef void *GoMap;
+typedef void *GoChan;
+typedef struct { void *t; void *v; } GoInterface;
+typedef struct { void *data; GoInt len; GoInt cap; } GoSlice;
+
+#endif
+
+/* End of boilerplate cgo prologue.  */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+// AddFile adds a file to IPFS
+//
+extern char* AddFile(char* repoPath, char* filePath, _Bool onlyHash);
+
+// FreeString is a no-op for now - we'll let Go's garbage collection handle the memory
+//
+extern void FreeString(char* str);
+
+// Download retrieves a file or directory from IPFS
+//
+extern int Download(char* repoPath, char* cidStr, char* destPath);
+
+// PinCID pins a CID to the IPFS node
+//
+extern int PinCID(char* repoPath, char* cidStr);
+
+// UnpinCID unpins a CID from the IPFS node
+//
+extern int UnpinCID(char* repoPath, char* cidStr);
+
+// ListPins returns a list of pinned CIDs
+//
+extern char* ListPins(char* repoPath);
+
+// RemoveCID removes a pinned CID from IPFS (alias for UnpinCID for clarity)
+//
+extern int RemoveCID(char* repoPath, char* cidStr);
+
+// P2PForward creates a libp2p stream mounting forwarding connection
+//
+extern int P2PForward(char* repoPath, char* proto, char* listenAddr, char* targetPeerID);
+
+// P2PListen creates a libp2p service that listens for connections on the given protocol
+//
+extern int P2PListen(char* repoPath, char* proto, char* targetAddr);
+
+// P2PClose closes p2p listener or stream
+//
+extern int P2PClose(char* repoPath, char* proto, char* listenAddr, char* targetAddr, _Bool _all, _Bool listeners, _Bool forwarders);
+
+// P2PListListeners lists active p2p listeners
+//
+extern char* P2PListListeners(char* repoPath);
+
+// P2PEnable ensures p2p functionality is enabled in the config
+//
+extern int P2PEnable(char* repoPath);
+
+// P2PListForwards lists active p2p forwarding connections
+//
+extern char* P2PListForwards(char* repoPath);
+
+// P2PCloseAllListeners closes all p2p listeners
+//
+extern int P2PCloseAllListeners(char* repoPath);
+
+// P2PCloseAllForwards closes all p2p forwards
+//
+extern int P2PCloseAllForwards(char* repoPath);
+
+// ConnectToPeer connects to a peer
+//
+extern int ConnectToPeer(char* repoPath, char* peerAddr);
+
+// ListPeers connects to a peer
+//
+extern char* ListPeers(char* repoPath);
+
+// ListPeers connects to a peer
+//
+extern char* ListPeersIDs(char* repoPath);
+
+// FindPeer connects to a peer
+//
+extern char* FindPeer(char* repoPath, char* peerAddr, int timeOut);
+
+// PubSubListTopics lists the topics the node is subscribed to
+//
+extern char* PubSubListTopics(char* repoPath);
+
+// PubSubPublish publishes a message to a topic
+//
+extern int PubSubPublish(char* repoPath, char* topic, void* data, int dataLen);
+
+// PubSubSubscribe subscribes to a topic
+//
+extern long long PubSubSubscribe(char* repoPath, char* topic);
+
+// PubSubNextMessage gets the next message from a subscription
+//
+extern char* PubSubNextMessage(long long subID);
+
+// PubSubUnsubscribe unsubscribes from a topic
+//
+extern int PubSubUnsubscribe(long long subID);
+
+// PubSubPeers lists peers participating in a topic
+//
+extern char* PubSubPeers(char* repoPath, char* topic);
+
+// PubSubCloseRepoSubscriptions closes all active pubsub subscriptions for a specific repository
+//
+extern int PubSubCloseRepoSubscriptions(char* repoPath);
+
+// PubSubCloseAllSubscriptions closes all active pubsub subscriptions across all repositories
+//
+extern int PubSubCloseAllSubscriptions();
+
+// CreateRepo initializes a new IPFS repository
+//
+extern int CreateRepo(char* repoPath);
+extern int RunNode(char* repoPath);
+
+// PubSubEnable enables pubsub on an IPFS node configuration
+//
+extern int PubSubEnable(char* repoPath);
+extern char* TestGetString();
+
+// GetNodeID gets the ID of the IPFS node
+//
+extern char* GetNodeID(char* repoPath);
+
+// GetNodeMultiAddrs gets the ID of the IPFS node
+//
+extern char* GetNodeMultiAddrs(char* repoPath);
+
+// CleanupNode explicitly releases a node by path
+//
+extern int CleanupNode(char* repoPath);
+
+#ifdef __cplusplus
+}
+#endif

libkubo/libkubo_loader.py

@@ -0,0 +1,88 @@
+import os
+from cffi import FFI
+import platform
+from pathlib import Path
+
+ffi = FFI()
+
+
+def is_android() -> bool:
+    """Check if OS is android."""
+    if "ANDROID_ROOT" in os.environ and "ANDROID_DATA" in os.environ:
+        return True
+    return (
+        "android" in platform.release().lower()
+        or "android" in platform.version().lower()
+    )
+
+
+system = platform.system()
+machine = platform.machine().lower()
+
+if system == "Windows":
+    if machine in ("x86_64", "amd64"):
+        lib_name = "libkubo_windows_x86_64.dll"
+        # header_name = "libkubo_windows_x86_64.h"
+        # windows header causes problems, so parse linux header instead
+        header_name = "libkubo_linux_x86_64.h"
+    # elif machine in ("aarch64", "arm64"):
+    #     lib_name = "libkubo_windows_arm64.dll"
+    #     header_name = "libkubo_windows_arm64.h"
+    else:
+        raise RuntimeError(f"Unsupported Windows architecture: {machine}")
+
+elif system == "Darwin":
+    lib_name = "libkubo.dylib"
+    header_name = "libkubo.h"
+
+elif system == "Linux":
+    if is_android():
+        if machine in ("aarch64", "arm64"):
+            lib_name = "libkubo_android_28_arm64_v8a.so"
+            header_name = "libkubo_android_28_arm64_v8a.h"
+        else:
+            raise RuntimeError(f"Unsupported Android arch: {machine}")
+    else:
+        if machine in ("x86_64", "amd64"):
+            lib_name = "libkubo_linux_x86_64.so"
+            header_name = "libkubo_linux_x86_64.h"
+        elif machine in ("aarch64", "arm64"):
+            lib_name = "libkubo_linux_arm64.so"
+            header_name = "libkubo_linux_arm64.h"
+        elif machine.startswith("armv7") or machine == "armv7l":
+            lib_name = "libkubo_linux_armhf.so"
+            header_name = "libkubo_linux_armhf.h"
+        else:
+            raise RuntimeError(f"Unsupported Linux architecture: {machine}")
+else:
+    raise RuntimeError(f"Unsupported platform: {system} {machine}")
+
+print(lib_name)
+print(header_name)
+
+# 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]