Improves the install script so the client can be installed alongside the rest

Author: sr-gi

CONTRIBUTING.md

@@ -104,3 +104,10 @@ We use [pytest](https://docs.pytest.org/en/latest/) to build and run tests. Test
 
 We require that all commits to be merge into master are signed. You can enable commit signing on GitHub by following [Signing commits](https://help.github.com/en/github/authenticating-to-github/signing-commits).
 
+## Installing the development client
+
+You can install the development client for easier testing by setting the development flag (DEV=1) when installing `teos`.
+
+```
+DEV=1 python setup.py install
+```

common/setup.py

@@ -1,18 +1,13 @@
 # Install 
 
-`teos-client` has some dependencies that can be satisfied by following [DEPENDENCIES.md](DEPENDENCIES.md). If your system already satisfies the dependencies, you can skip that part.
-
-Once the dependencies are satisfied, `teos-client` can be installed from source by running:
+`teos-client` gets installed alongside `teos` as long as you set the development flag when installing `teos`:
 
 ```
-python setup.py install
+DEV=1 python setup.py install
 ```
 
-`teos-client` will be available in the shell once the installation is completed.
-
-## Modify configuration parameters
-If you'd like to modify some of the configuration defaults (such as the user directory, where the logs and appointment receipts will be stored) you can do so in the config file located at:
+You can also get a standalone client from pip:
 
-	 <data_dir>/.teos_client/teos_client.conf
-	 
-`<data_dir>` defaults to your home directory (`~`).
+```
+pip install teos-client
+```

contrib/client/INSTALL.md

@@ -1,3 +1,3 @@
-cryptography
+cryptography>=2.8
 requests
 structlog

contrib/client/requirements.txt

@@ -19,7 +19,7 @@
 from common.config_loader import ConfigLoader
 from common.cryptographer import Cryptographer
 from common.tools import setup_data_folder
-from common.exceptions import BasicException, InvalidKey, InvalidParameter, SignatureError, TowerResponseError
+from common.exceptions import BasicException, InvalidKey, InvalidParameter, TowerResponseError
 from common.tools import is_256b_hex_str, is_locator, compute_locator, is_compressed_pk
 
 from contrib.client import DEFAULT_CONF, DATA_DIR, CONF_FILE_NAME

contrib/client/setup.py

@@ -1,4 +1,5 @@
 import os
+import glob
 import shutil
 import setuptools
 
@@ -10,15 +11,17 @@
 with open("requirements.txt") as f:
     requirements = [r for r in f.read().split("\n") if len(r)]
 
+# Remove undesired files
+wildcards = ["**/__pycache__", "**/.DS_Store"]
+for entry in wildcards:
+    for file_dir in glob.glob(entry, recursive=True):
+        if os.path.isdir(file_dir):
+            shutil.rmtree(file_dir)
+        elif os.path.isfile(file_dir):
+            os.remove(file_dir)
 
 PACKAGES = ["common", "teos", "teos.cli", "teos.protobuf", "teos.utils"]
 
-# Remove undesired files
-for package in PACKAGES:
-    if os.path.exists(f"{package}/__pycache__"):
-        shutil.rmtree(f"{package}/__pycache__")
-    if os.path.exists(f"{package}/.DS_Store"):
-        os.remove(f"{package}/.DS_Store")
 
 CLASSIFIERS = [
     "Programming Language :: Python",
@@ -33,6 +36,22 @@
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 
+CONSOLE_SCRIPTS = ["teosd=teos.teosd:run", "teos-cli=teos.cli.teos_cli:run"]
+
+# Add additional scripts if DEV=1
+if os.getenv("DEV", False):
+    # Add missing requirements
+    with open("contrib/client/requirements.txt") as f:
+        requirements_client = [r for r in f.read().split("\n") if len(r)]
+
+    requirements = list(set(requirements).union(requirements_client))
+
+    # Extend packages
+    PACKAGES.extend(["contrib", "contrib.client"])
+
+    # Add console scripts
+    CONSOLE_SCRIPTS.append("teos-client=contrib.client.teos_client:run")
+
 setuptools.setup(
     name="teos",
     version=__version__,
@@ -46,5 +65,5 @@
     classifiers=CLASSIFIERS,
     python_requires=">=3.7",
     install_requires=requirements,
-    entry_points={"console_scripts": ["teosd=teos.teosd:run", "teos-cli=teos.cli.teos_cli:run"]},
+    entry_points={"console_scripts": CONSOLE_SCRIPTS},
 )