varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2025-12-31 20:36:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

set demos as console scripts, update chat instructions

Browse Source
This commit is contained in:
pacrob
2024-12-20 13:23:04 -07:00
committed by Paul Robinson
parent bc90632f9d
commit a72dbaa58d
9 changed files with 77 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/examples.ping.rst
View File

@ -1,17 +1,31 @@
Ping Demo
=========
Copy the code below into a file called ``ping.py``.
Install dependencies, preferably in a virtual environment, with:
This example demonstrates how to use the libp2p ``ping`` protocol.
.. code-block:: bash
.. code-block:: console
python -m pip install libp2p
$ python -m pip install libp2p
Collecting libp2p
...
Successfully installed libp2p-x.x.x
$ ping-demo
Run this from the same folder in another console:
Run the demo with ``python ping.py`` and copy the output.
ping-demo -p 8001 -d /ip4/127.0.0.1/tcp/8000/p2p/QmXfptdHU6hqG95JswxYVUH4bphcK8y18mhFcgUQFe6fCN
Open a second terminal, navigate to the folder that contains ``ping.py``, then paste
and run the copied line.
Waiting for incoming connection...
Copy the line that starts with ``ping-demo -p 8001``, open a new terminal in the same
folder and paste it in:
.. code-block:: console
$ ping-demo -p 8001 -d /ip4/127.0.0.1/tcp/8000/p2p/QmXfptdHU6hqG95JswxYVUH4bphcK8y18mhFcgUQFe6fCN
sending ping to QmXfptdHU6hqG95JswxYVUH4bphcK8y18mhFcgUQFe6fCN
received pong from QmXfptdHU6hqG95JswxYVUH4bphcK8y18mhFcgUQFe6fCN
The full source code for this example is below:
.. literalinclude:: ../examples/echo/echo.py
:language: python