implement __main__.py enty points (#409)

* convert `server` and `client` to full sub-packages

* Server: implement a `__main__` entrypint

* small fixes and typos

Author: Cube707

doc/API/server.rst

@@ -1,5 +1,34 @@
 Server
 ======
 
+If you just need a quick server with some default values initalised, this package provides a default implementation.
+To use it you first need to install some aditional dependencies, using:
+
+.. code:: bash
+
+   pip install python-snap7[cli]
+
+Now you can start it using one of the following commands:
+
+.. code:: bash
+
+   python -m snap7.server
+   # or, if your Python `Scripts/` folder is on PATH:
+   snap7-server
+
+You can optionally provide the port to be used as an argument, like this:
+
+.. code:: bash
+
+   python -m snap7.server --port 102
+
+----
+
 .. automodule:: snap7.server
-   :members:
+   :members:
+
+----
+
+.. automodule:: snap7.server.__main__
+
+   .. autofunction:: main(port, dll)

setup.py

@@ -7,6 +7,7 @@
 tests_require = ['pytest', 'pytest-asyncio', 'mypy', 'pycodestyle', 'types-setuptools']
 
 extras_require = {
+    'cli': ['click'],
     'test': tests_require,
     'doc': ['sphinx', 'sphinx_rtd_theme'],
 }
@@ -38,7 +39,11 @@ def read(fname):
     package_data={'snap7': ['py.typed']},
     license='MIT',
     long_description=read('README.rst'),
-    scripts=['snap7/bin/snap7-server.py'],
+    entry_points={
+        'console_scripts': [
+            'snap7-server = snap7.server.__main__:main',
+        ]
+    },
     classifiers=[
         "Development Status :: 5 - Production/Stable",
         "Environment :: Console",
@@ -50,7 +55,7 @@ def read(fname):
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",        
+        "Programming Language :: Python :: 3.10",
     ],
     python_requires='>=3.7',
     extras_require=extras_require,

snap7/bin/__init__.py

@@ -8,11 +8,11 @@
 from datetime import datetime
 from typing import List, Optional, Tuple, Union
 
-from .common import check_error, ipv4, load_library
-from .types import S7SZL, Areas, BlocksList, S7CpInfo, S7CpuInfo, S7DataItem
-from .types import S7OrderCode, S7Protection, S7SZLList, TS7BlockInfo, WordLen
-from .types import S7Object, buffer_size, buffer_type, cpu_statuses, param_types
-from .types import S7CpuInfo, RemotePort, wordlen_to_ctypes, block_types
+from ..common import check_error, ipv4, load_library
+from ..types import S7SZL, Areas, BlocksList, S7CpInfo, S7CpuInfo, S7DataItem
+from ..types import S7OrderCode, S7Protection, S7SZLList, TS7BlockInfo, WordLen
+from ..types import S7Object, buffer_size, buffer_type, cpu_statuses, param_types
+from ..types import S7CpuInfo, RemotePort, wordlen_to_ctypes, block_types
 logger = logging.getLogger(__name__)
 
 

snap7/bin/snap7-server.py

@@ -8,11 +8,10 @@
 import logging
 from typing import Any, Tuple, Callable, Optional
 
-from . import server as snap7server
-from .common import ipv4, check_error, load_library
-from .types import SrvEvent, LocalPort, cpu_statuses, server_statuses
-from .types import longword, wordlen_to_ctypes, WordLen, S7Object
-from .types import srvAreaDB, srvAreaPA, srvAreaTM, srvAreaCT
+from ..common import ipv4, check_error, load_library
+from ..types import SrvEvent, LocalPort, cpu_statuses, server_statuses
+from ..types import longword, wordlen_to_ctypes, WordLen, S7Object
+from ..types import srvAreaDB, srvAreaPA, srvAreaTM, srvAreaCT
 
 logger = logging.getLogger(__name__)
 
@@ -384,7 +383,7 @@ def mainloop(tcpport: int = 1102, init_standard_values: bool = False):
         init_standard_values: if `True` will init some defaults values to be read on DB0.
     """
 
-    server = snap7server.Server()
+    server = Server()
     size = 100
     DBdata = (wordlen_to_ctypes[WordLen.Byte.value] * size)()
     PAdata = (wordlen_to_ctypes[WordLen.Byte.value] * size)()

snap7/client.py snap7/client/__init__.pysnap7/client.py renamed to snap7/client/__init__.py

@@ -0,0 +1,54 @@
+"""
+The :code:`__main__` module is used as an entrypoint when calling the module from the terminal using python -m flag.
+It contains functions providing a comandline interface to the server module.
+
+Its :code:`main()` function is also exported as an consol-entrypoint.
+"""
+
+import logging
+
+try:
+    import click
+except ImportError as e:
+    print(e)
+    print("Try using 'pip install python-snap7[cli]'")
+    exit()
+
+from snap7 import __version__
+from snap7.common import load_library
+from snap7.server import mainloop
+
+logger = logging.getLogger("Snap7.Server")
+
+
+@click.command()
+@click.option("-p", "--port", default=1102, help="Port the server will listen on.")
+@click.option(
+    "--dll",
+    hidden=True,
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, resolve_path=True),
+    help="Path to the snap7 DLL (for emergencies if it can't be put on PATH).",
+)
+@click.option("-v", "--verbose", is_flag=True, help="Also print debug-output.")
+@click.version_option(__version__)
+@click.help_option("-h", "--help")
+def main(port, dll, verbose):
+    """Start a S7 dummy server with some default values."""
+
+    # setup logging
+    if verbose:
+        logging.basicConfig(format="[%(levelname)s]: %(message)s", level=logging.DEBUG)
+    else:
+        logging.basicConfig(format="[%(levelname)s]: %(message)s", level=logging.INFO)
+
+    # normally the snap7.dll should be on PATH and will be loaded automatically by the mainloop,
+    # but for emergencies, we allow the DLL's location to be passed as an argument and load it here
+    if dll:
+        load_library(dll)
+
+    # start the server mainloop
+    mainloop(port, init_standard_values=True)
+
+
+if __name__ == "__main__":
+    main()