Merge branch 'main' into develop

franaudo · franaudo · commit ddac2827ba90 · 2021-05-05T10:24:40.000+02:00
diff --git a/README.rst b/README.rst
@@ -27,13 +27,6 @@ Currently supported bots:
 
 Full documentation: https://franaudo.github.io/codebots/latest/.
 
-.. note::
-
-    This pacakge is a WIP! Expect things to be very different among versions. However,
-    the stable releases will always work and pass all the tests.
-
-    If you want to access the latest functionalities, clone the GitHub repo and switch
-    to the `develop` branch, although it is very likely that things won't work! :)
 
 Features
 --------
diff --git a/docs/conf.py b/docs/conf.py
@@ -44,7 +44,7 @@
 # copyright = "2021, Francesco Ranaudo"
 # author = "Francesco Ranaudo"
 # # The full version, including alpha/beta/rc tags
-# release = "0.7.1"
+# release = "0.8.2"
 # # release = LooseVersion(sphinx_material.__version__).vstring
 
 # # -- General configuration ---------------------------------------------
@@ -116,7 +116,6 @@
 # ]
 
 
-
 # # napoleon options
 # napoleon_google_docstring = False
 # napoleon_numpy_docstring = True
@@ -459,6 +458,8 @@
 autoclass_content = "class"
 
 # Enable eval_rst in markdown
+
+
 def setup(app):
     app.add_config_value(
         "recommonmark_config",
@@ -472,5 +473,3 @@ def setup(app):
         objname="configuration value",
         indextemplate="pair: %s; configuration value",
     )
-
-
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,6 +13,16 @@ Welcome to codebots's documentation!
         :target: https://github.com/franaudo/codebots/actions/workflows/codeql-analysis.yml
         :alt: CodeQL
 
+
+.. note::
+
+    This pacakge is a WIP! Expect things to be very different among versions. However,
+    the stable releases will always work and pass all the tests.
+
+    If you want to access the latest functionalities, clone the GitHub repo and switch
+    to the `develop` branch, although it is very likely that things won't work! :)
+
+
 .. toctree::
    :maxdepth: 1
    :caption: Contents:
diff --git a/setup.cfg b/setup.cfg
@@ -1,11 +1,11 @@
 [bumpversion]
-current_version = 0.7.1
+current_version = 0.8.2
 message = Bump version to {new_version}
 commit = True
 tag = True
 
 [options]
-package_dir = 
+package_dir =
 	=src
 packages = find:
 
@@ -28,13 +28,13 @@ convention = numpy
 
 [tool:pytest]
 testpaths = tests
-norecursedirs = 
+norecursedirs =
 	migrations
-python_files = 
+python_files =
 	test_*.py
 	*_test.py
 	tests.py
-addopts = 
+addopts =
 	-ra
 	--strict
 	--doctest-modules
diff --git a/setup.py b/setup.py
@@ -10,15 +10,15 @@
 with open("CHANGELOG.rst") as history_file:
     history = history_file.read()
 
-requirements = ["Click>=7.0", "slack_sdk", "yagmail", "gitpython"]
+requirements = ["Click>=7.0", "slack_sdk", "yagmail", "gitpython", "paramiko"]
 
 setup_requirements = ["pytest-runner", ]
 
 test_requirements = ["pytest>=3", ]
 
 setup(
     name="codebots",
-    version="0.7.1",
+    version="0.8.2",
     author="Francesco Ranaudo",
     author_email="ranaudo@arch.ethz.ch",
     python_requires=">=3.5",
@@ -46,7 +46,7 @@
     },
     install_requires=requirements,
     license="MIT license",
-    long_description=readme + "\n\n" + history,
+    long_description=readme,
     include_package_data=True,
     keywords="codebots",
     packages=["codebots"],
diff --git a/src/codebots/__init__.py b/src/codebots/__init__.py
@@ -1,6 +1,6 @@
 __author__ = """Francesco Ranaudo"""
 __email__ = 'francesco.ranaudo@gmail.com'
-__version__ = '0.7.1'
+__version__ = '0.8.2'
 
 import os
 import json
diff --git a/src/codebots/cli/cli.py b/src/codebots/cli/cli.py
@@ -246,18 +246,18 @@ def set_token(hostname, username, password, pvtkey):
 @sshbot.command()
 @click.option('--ssh_folder', default=None, help='path where the key pair will be saved, by default None (the `USER/.ssh` folder will be used)')
 @click.option('--password', default=None, help='encrypt the private key with a password')
-def genkeys(ssh_folder):
+def genkeys(ssh_folder, password):
     """Create a set of public and private keys and save them in the given folder.
     """
-    out = gen_keypair(ssh_folder)
+    out = gen_keypair(ssh_folder, password)
     click.echo(out)
 
 
 @sshbot.command()
 @click.argument('hostname')
 @click.argument('username')
 @click.argument('password')
-@click.option('--ssh_folder', help='path where the key pair will be saved')
+@click.option('--ssh_folder', default=None, help='path where the key pair will be saved')
 def link_keys(hostname, username, password, ssh_folder):
     """Adds the public key to the server's list.\n
 
@@ -271,6 +271,8 @@ def link_keys(hostname, username, password, ssh_folder):
         password on the server, by default empty.\n
     """
     bot = sshBot(config_file=None, hostname=hostname, username=username, password=password, pvtkey="")
+    if not ssh_folder:
+        ssh_folder = os.path.join(str(Path.home()), '.ssh')
     out = add_pubkey_to_server(bot, ssh_folder)
     click.echo(out)
     out = add_token("ssh", hostname=hostname, username=username, password="", pvtkey=os.path.join(ssh_folder, 'id_rsa'))
diff --git a/src/codebots/utilities/ssh.py b/src/codebots/utilities/ssh.py
@@ -41,8 +41,6 @@ def add_pubkey_to_server(bot, ssh_folder, os_type='linux'):
     --------
     This works only on linux servers.
     """
-    if not ssh_folder:
-        ssh_folder = os.path.join(str(Path.home()), '.ssh')
     with open(os.path.join(ssh_folder, 'id_rsa.pub'), "r") as pubkey_file:
         pubkey = pubkey_file.readline()
     bot.execute_cmds(commands=['(umask 077 && test -d ~/.ssh || mkdir ~/.ssh)',
