Metadata-Version: 2.1
Name: ndn-svs
Version: 0.1.4
Summary: The NDN State Vector Sync (SVS) Protocol in Python 3
Home-page: https://github.com/justincpresley/ndn-python-svs
Author: Justin C Presley
Author-email: justincpresley@gmail.com
Maintainer: Justin C Presley
Maintainer-email: justincpresley@gmail.com
License: LGPL-2.1 License
Download-URL: https://pypi.python.org/pypi/ndn-svs
Description: ---
        
        # ndn-python-svs: State Vector Sync NDN Python library
        
        This python library implements the [State Vector Sync (SVS) protocol](https://named-data.github.io/StateVectorSync/) to synchronise states between multiple clients over NDN for distributed realtime applications.
        
        > This is an official implementation but considered 'experimental'. If there are any concerns or suggestions, please create [a new issue](https://github.com/justincpresley/ndn-python-svs/issues).
        
        ndn-python-svs uses the [python-ndn](https://github.com/named-data/python-ndn) library for it's implementation.
        
        ---
        
        ## Installation
        
        ### Prerequisites
        
        * [python-ndn](https://python-ndn.readthedocs.io/en/latest/src/installation.html)
        
        * [nfd](https://named-data.net/doc/NFD/0.5.0/INSTALL.html)
        
        * [pip](https://pip.pypa.io/en/stable/installing/) if downloading via python pip
        
        ### From Pip
        
        Download the python pip library [ndn-svs](https://pypi.org/project/ndn-svs/)
        
        ### From Source
        
        Clone or Fork the github repository [ndn-python-svs](https://github.com/justincpresley/ndn-python-svs)
        
        ### Examples
        
        To try out the chat demo application from source, follow the below steps.
        
        To create a chat client, simply run this in the home directory of the repo:
        ```
        python3 examples/chat_node.py -n NODE_NAME [-gp GROUP_PREFIX] [-h]
        ```
        You may create as many of these as possible and all clients will sync up using SVS.
        
        ### For All Usage
        
        Before you run the program, you must register the group prefix as multi-cast (even if you did not specifically define the group prefix):
        ```
        nfdc strategy set <group-prefix> /localhost/nfd/strategy/multicast/%FD%03
        ```
        The default (unless specified) **group prefix** is `/svs` for any build-in examples.
        
        [More on setting different strategies (like mutli-cast) for prefixes.](https://named-data.net/doc/NFD/current/manpages/nfdc-strategy.html)
        
        ---
        
        ## License and Authors
        
        ndn-python-svs is an open source project that is licensed. See [`LICENSE.md`](https://github.com/justincpresley/ndn-python-svs/blob/master/LICENSE.md) for more information.
        
        Please note: This is only a implementation in python and does not claim any credit towards the [actual design of SVS](https://named-data.github.io/StateVectorSync/).
        
        The Names of all authors associated with this implementation project are below:
        
          * *Justin C Presley* (justincpresley)
        
        ---
        
Keywords: NDN SVS
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Internet
Classifier: Topic :: System :: Networking
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
