simpledht 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

simpledht/__init__.py

@@ -20,7 +20,7 @@ Example usage:
     node.bootstrap('other_node_ip:5000')
 """
 
-__version__ = "0.1.2"
+__version__ = "0.1.4"
 
 from .dht_node import DHTNode
 from .cli import main as cli_main

simpledht-0.1.4.dist-info/METADATA

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: simpledht
+Version: 0.1.4
+Summary: A simple distributed hash table implementation
+Home-page: https://github.com/dhruvldrp9/simpledht
+Author: Dhruvkumar Patel
+Author-email: dhruv.ldrp9@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.1
+Requires-Dist: click>=8.0.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Distributed Hash Table (DHT) Implementation
+
+A Python-based Distributed Hash Table implementation that allows nodes to connect across different networks using IP addresses. This implementation supports key-value storage and retrieval across multiple nodes.
+
+## Features
+
+- Cross-network node communication
+- Key-value storage and retrieval
+- Automatic node discovery
+- Data replication between nodes
+- Data synchronization when joining the network
+- Reliable bootstrapping with retry mechanism
+- Simple CLI interface
+- Public IP detection
+- Local network support
+- Python library interface for programmatic use
+
+## Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install simpledht
+```
+
+### From Source
+
+1. Clone the repository:
+```bash
+git clone https://github.com/dhruvldrp9/SimpleDHT
+cd SimpleDHT
+```
+
+2. Create and activate a virtual environment:
+```bash
+python -m venv env
+source env/bin/activate  # On Windows: env\Scripts\activate
+```
+
+3. Install the package in development mode:
+```bash
+pip install -e .
+```
+
+## Usage
+
+### As a Python Library
+
+The package can be used programmatically in your Python code:
+
+```python
+from simpledht import DHTNode
+
+# Create and start a node
+node = DHTNode(host='0.0.0.0', port=5000)
+node.start()
+
+# Store data
+node.put('mykey', 'myvalue')
+
+# Retrieve data
+value = node.get('mykey')
+
+# Connect to another node
+node.bootstrap('other_node_ip:5000')
+
+# Stop the node when done
+node.stop()
+```
+
+See the `examples/` directory for more detailed usage examples:
+- `basic_usage.py`: Simple example of creating and connecting nodes
+- `distributed_storage.py`: Advanced example showing distributed storage with multiple nodes
+
+### Command Line Interface
+
+#### Starting a Node
+
+To start a new DHT node:
+
+```bash
+python -m simpledht.cli start --host 0.0.0.0 --port 5000
+```
+
+To start a node and connect to existing nodes:
+
+```bash
+python -m simpledht.cli start --host 0.0.0.0 --port 5001 --bootstrap "PUBLIC_IP:5000"
+```
+
+#### Storing Data
+
+To store a key-value pair:
+
+```bash
+python -m simpledht.cli put --host PUBLIC_IP --port 5000 mykey "my value"
+```
+
+#### Retrieving Data
+
+```bash
+python -m simpledht.cli get --host PUBLIC_IP --port 5000 mykey
+```
+
+### Cross-Network Example
+
+1. Start Node 1 (First network):
+```bash
+python -m simpledht.cli start --host 0.0.0.0 --port 5000
+```
+
+2. Start Node 2 (Second network):
+```bash
+python -m simpledht.cli start --host 0.0.0.0 --port 5000 --bootstrap "NODE1_PUBLIC_IP:5000"
+```
+
+3. Store and retrieve data:
+```bash
+# Store on Node 1
+python -m simpledht.cli put --host NODE1_PUBLIC_IP --port 5000 test_key "test_value"
+
+# Retrieve from Node 2
+python -m simpledht.cli get --host NODE2_PUBLIC_IP --port 5000 test_key
+```
+
+## Network Configuration
+
+### Firewall Setup
+
+Ensure the UDP port (default: 5000) is open in your firewall:
+
+```bash
+# For UFW (Ubuntu)
+sudo ufw allow 5000/udp
+
+# For iptables
+sudo iptables -A INPUT -p udp --dport 5000 -j ACCEPT
+```
+
+### Port Forwarding
+
+If your node is behind a NAT router:
+1. Access your router's admin interface
+2. Set up port forwarding for UDP port 5000
+3. Forward to your node's local IP address
+
+## New Features in Version 0.1.3
+
+- **Improved Bootstrap Mechanism**: Added retry logic for more reliable connections across networks
+- **Data Synchronization**: Nodes automatically sync data when joining the network
+- **Enhanced Error Handling**: Better handling of network timeouts and connection issues
+- **Full Data Replication**: All nodes maintain a complete copy of the data for redundancy
+- **Alternative Command Method**: Added support for running via `python -m simpledht.cli`
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Connection Timeout**
+   - Check if the target node is running
+   - Verify firewall settings
+   - Ensure port forwarding is configured correctly
+   - Try increasing the timeout: `--timeout 10`
+
+2. **Address Already in Use**
+   - The port is already being used by another process
+   - Try a different port number
+   - Check running processes: `netstat -tuln | grep 5000`
+
+3. **No Response from Node**
+   - Verify the node is running
+   - Check network connectivity: `ping NODE_IP`
+   - Test port connectivity: `nc -vzu NODE_IP 5000`
+
+### Error Messages
+
+- `Failed to bootstrap with IP:PORT`: Invalid bootstrap node format
+- `No response received`: Node is not responding
+- `Address already in use`: Port conflict
+- `Failed to get public IP`: Network connectivity issue
+- `Connection attempt X/3 timed out, retrying...`: Network latency or connectivity issues
+- `simpledht: command not found`: The command-line tool is not in your PATH. Use the Python module directly: `python -m simpledht.cli`
+
+## Architecture
+
+The DHT implementation uses:
+- UDP sockets for communication
+- SHA-256 for node ID generation
+- Automatic public IP detection
+- Data replication between nodes
+- Bootstrap nodes for network discovery
+- Retry mechanism for reliable connections
+
+## Security Considerations
+
+- This is a basic implementation and should not be used in production without additional security measures
+- Consider adding:
+  - Encryption for data in transit
+  - Authentication for node joining
+  - Rate limiting to prevent abuse
+  - Input validation
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Commit your changes
+4. Push to the branch
+5. Create a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

simpledht-0.1.4.dist-info/RECORD

@@ -0,0 +1,10 @@
+simpledht/__init__.py,sha256=wKPkOXmeKWw7EGzWO8OfiniWd9tdJ2ALL0Ee4pc-ZKw,546
+simpledht/cli.py,sha256=9QgsyZv1-SKwblj2hYLsGKRjiCyBFjlGalafdqhoXrk,4877
+simpledht/dht_node.py,sha256=58fd7Yq8gPLVbHaaJMW-9gnrC2YjPMF0EtD3I81EI6Q,14864
+simpledht/test_dht.py,sha256=tsWGhtLkTArFJIdkaWManekhFx2KCUO0Gp93EGBUAlw,2346
+simpledht-0.1.4.dist-info/licenses/LICENSE,sha256=MrSAzCY_7J3C4Hp8PaXaaFJP2ygfmuAWoLTVowEE3B0,1073
+simpledht-0.1.4.dist-info/METADATA,sha256=yhcyaR_fM-5u2NoyzKgezVwb1AwSPuupgZrL-IpTB_M,6151
+simpledht-0.1.4.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+simpledht-0.1.4.dist-info/entry_points.txt,sha256=Hm3BYz1MykAhg94m3JSYsMcdEQEia3bdRocokc-0wxs,49
+simpledht-0.1.4.dist-info/top_level.txt,sha256=VjRxeoXfQJeoPoFhr5JGGMAI5NSLkYJl0WbySmpZ4bs,10
+simpledht-0.1.4.dist-info/RECORD,,

simpledht-0.1.2.dist-info/METADATA

@@ -1,27 +0,0 @@
-Metadata-Version: 2.4
-Name: simpledht
-Version: 0.1.2
-Summary: A simple distributed hash table implementation
-Home-page: https://github.com/dhruvldrp9/simpledht
-Author: Dhruvkumar Patel
-Author-email: dhruv.ldrp9@gmail.com
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests>=2.25.1
-Requires-Dist: click>=8.0.1
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-A simple distributed hash table implementation

simpledht-0.1.2.dist-info/RECORD

@@ -1,10 +0,0 @@
-simpledht/__init__.py,sha256=UMGuX6JHuDsQG_JuvBv4Q5JT2Yq9zzPwTuqgRdHJVow,546
-simpledht/cli.py,sha256=9QgsyZv1-SKwblj2hYLsGKRjiCyBFjlGalafdqhoXrk,4877
-simpledht/dht_node.py,sha256=58fd7Yq8gPLVbHaaJMW-9gnrC2YjPMF0EtD3I81EI6Q,14864
-simpledht/test_dht.py,sha256=tsWGhtLkTArFJIdkaWManekhFx2KCUO0Gp93EGBUAlw,2346
-simpledht-0.1.2.dist-info/licenses/LICENSE,sha256=MrSAzCY_7J3C4Hp8PaXaaFJP2ygfmuAWoLTVowEE3B0,1073
-simpledht-0.1.2.dist-info/METADATA,sha256=n9kVjGyjUno8VTeN5IgM2isJO2UVBxfsm_p51ckxy98,779
-simpledht-0.1.2.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-simpledht-0.1.2.dist-info/entry_points.txt,sha256=Hm3BYz1MykAhg94m3JSYsMcdEQEia3bdRocokc-0wxs,49
-simpledht-0.1.2.dist-info/top_level.txt,sha256=VjRxeoXfQJeoPoFhr5JGGMAI5NSLkYJl0WbySmpZ4bs,10
-simpledht-0.1.2.dist-info/RECORD,,