Giter VIP home page Giter VIP logo

kad.py's Introduction

kad.py

Python3 implementation of the Kademlia DHT data store.

Useful for distributing a key-value store in a decentralized manner.

To create a new DHT swarm, just call DHT() with the host and port that you will listen on. To join an existing DHT swarm, also provide bootstrap host and port numbers of any existing node. The nodes will discover the rest of the swarm as appropriate during usage.

Example: A two-node DHT

from kad import DHT

host1, port1 = 'localhost', 3000
dht1 = DHT(host1, port1)
host2, port2 = 'localhost', 3001
dht2 = DHT(host2, port2, seeds=[(host1, port1)])
dht1["my_key"] = [u"My", u"json-serializable", u"Object"]

print (dht2["my_key"])	# blocking get
dht2.get ("my_key", lambda data: print (data)) # threaded get

Example: Persistent storage

We can use a custom storage for local data. Storage parameter must an object with getitem and setitem. In this example we use shelve to create a persistent storage.

from kad import DHT
import shelve

host, port = 'localhost', 3000
dht = DHT(host, port, storage=shelve.open ('sto.dat'))

Example: Custom hash function

By default, kad.py hash the keys with md5 function. We can provide a custom hash_function. Note: Keep in mind that hash functions must return int values for this implementation.

from kad import DHT

host, port = 'localhost', 3000
dht = DHT(host, port, hash_function=lambda key: int(hashlib.sha256(key.encode('utf8')).hexdigest(), 16))

Example: Custom request handler

You can extend the default DHTRequestHandler to intercept any kind of messages.

from kad import *

class CustomRequestHandler (kad.DHTRequestHandler):
    def handle_store(self, message):
        print (message['value'])
        return super (CustomRequestHandler, self).handle_store (message)


d = DHT ('localhost', 3030, requesthandler=CustomRequestHandler)

d['ciao'] = {'hola': 12}

Example: Iterate over DHT keys

You can use the DHT object as iterator for stored keys.

from kad import DHT

d = DHT ('localhost', 3100)

d['ciao'] = 'mondo'
d['hello'] = 'world'

for key in d:
    print (key, d[key])

kad.py's People

Contributors

dakk avatar isaaczafuta avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

kad.py's Issues

Deletion

Hello,

It's not an issue only two simple questions about things which are not in the documentation.

It's possible to delete a key/value from the DHT ?
Is there an expiration time by default for the key/value ?

Thank you.

Data cache

Offline data cache to restore data after restart

Logger

Implement a cool logger to display debug informations about:

  • peer network
  • data requests / handling

Message validator

Implements the ability to inject a validator function for messages. A message is processed only if the validator function return true

Persistent storage fail

Getting keys with persistent storage fails.
Below how to replicate the error

from kad import DHT
import shelve

# bootstrap node
host1, port1 = 'localhost', 3000

# this node
host2, port2 = 'localhost', 3001
dht2 = DHT(host2, port2, seeds=[(host1,port1)], storage=shelve.open ('storage_two.dat'))

print (dht2["file00"])	# blocking get
dht2.get("file00", lambda d: print(d)) # threaded get
  File "two.py", line 12, in <module>
    print (dht2["file00"])	# blocking get
  File "/Users/frag/Documents/kad.py/kad/kad.py", line 199, in __getitem__
    if hashed_key in self.data:
  File "/usr/local/Cellar/python3/3.6.2/Frameworks/Python.framework/Versions/3.6/lib/python3.6/shelve.py", line 102, in __contains__
    return key.encode(self.keyencoding) in self.dict
AttributeError: 'int' object has no attribute 'encode'

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.