Basic documentation

Author: AlexisTM

.gitignore

@@ -103,3 +103,4 @@ venv.bak/
 # mypy
 .mypy_cache/
 .idea
+*/.vscode*

docs/index.rst

@@ -5,6 +5,11 @@ Welcome to RawSocketPy's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   installation
+   quicktest
+   raw_socket
+   server_mode
+
 Indices and tables
 ==================
 

docs/installation.rst

@@ -0,0 +1,28 @@
+Installation
+=======================================
+.. code-block:: bash
+   :caption: installation
+   :name: installation
+    # using pypi
+    sudo -H python -m pip install rawsocketpy
+
+    # for development
+    git clone https://github.com/AlexisTM/rawsocket_python
+    cd rawsocket_python
+    sudo python pip . -e
+
+    # manually
+    git clone https://github.com/AlexisTM/rawsocket_python
+    sudo python setup.py install
+
+
+`gevent` is an optional dependency that allow concurrency for the RawServer. 
+
+You can install it using: 
+
+.. code-block:: bash
+   :caption: installation
+   :name: installation
+
+   sudo -H python -m pip install gevent
+

docs/quicktest.rst

@@ -0,0 +1,30 @@
+Quicktest
+=======================================
+
+The simplest example to ensure the library is working for you is to take two machines (or one with two network cards) and run the following.
+
+> Ensure to set **your interface** name instead of **wlp2s0**.
+
+On the first machine:
+
+.. code-block:: bash
+   :caption: First machine
+   :name: First machine
+
+   sudo python -c "from rawsocketpy import RawSocket
+   sock = RawSocket('wlp2s0', 0xEEFA)
+   while True: print(sock.recv())"
+
+On the second machine:
+
+.. code-block:: bash
+   :caption: Second machine
+   :name: Second machine
+
+    sudo python -c "from rawsocketpy import RawSocket; import time
+    sock = RawSocket('wlp2s0', 0xEEFA)
+    while True:
+      sock.send('Boo')
+      print('Boo has been sent')
+      time.sleep(0.5)"
+

docs/raw_socket.rst

@@ -0,0 +1,7 @@
+Raw sockets
+============
+
+The raw sockets is the base of the library.   
+
+
+

docs/server_mode.rst

@@ -0,0 +1,42 @@
+Asynchronous Server with custom data handler
+==================
+
+To a raw server, you have the following options:
+
+* RawServer: Blocks for each message received until handled
+* RawServerCallback: Calls the callback and blocks until the callback returns
+* RawServerAsync: **if gevent available**, it will handle the incomming messages in a pool of Greenlets
+* RawServerAsyncCallback: **if gevent available**, it will add the callback in a pool of Greenlets
+
+.. code-block:: python
+   :caption: First machine
+   :name: First machine
+    
+   from rawsocketpy import RawRequestHandler, RawAsyncServerCallback
+   import time
+
+
+   def some_callback(handler, server):
+       print("callback")
+       handler.setup()
+       handler.handle()
+       handler.finish()
+
+
+   class LongTaskTest(RawRequestHandler):
+       def handle(self):
+           time.sleep(1)
+           print(self.packet)
+
+       def finish(self):
+           print("End")
+
+       def setup(self):
+           print("Begin") 
+
+
+   def main():
+       rs = RawAsyncServerCallback("wlp2s0", 0xEEFA, LongTaskTest, some_callback)
+       rs.spin()
+   if __name__ == '__main__':
+       main()

setup.py

@@ -4,8 +4,8 @@
     long_description = fh.read()
 
 setuptools.setup(name='rawsocketpy',
-      version='0.2',
-      description='This library allows you to implemnet a custom layer 2 communication using raw sockets in Python 2 and Python 3, synchronous and asynchronous, with and without callbacks.',
+      version='0.2.1',
+      description='This library allows you to implement a custom layer 2 communication using raw sockets in Python 2 and Python 3, synchronous and asynchronous, with and without callbacks.',
       long_description=long_description,
       long_description_content_type="text/markdown",
       url='https://github.com/AlexisTM/rawsocket_python',