GitHubSSHKey v0.4.0

.gitignore

@@ -157,4 +157,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

MANIFEST.in

@@ -0,0 +1,9 @@
+include LICENSE
+include README.md
+include requirements.txt
+include tox.ini
+include setup.cfg
+include setup.py
+global-exclude tests/*
+global-exclude data/*
+global-exclude requirements/*

README.md

@@ -1,2 +1,167 @@
 # github-ssh-key
-github-ssh-key
+___github-ssh-key___ - GitHub ssh key manager. Console utility for creating, getting, testing, 
+using public ssh keys for GitHub.
+***
+
+![GitHub top language](https://img.shields.io/github/languages/top/smartlegionlab/github-ssh-key)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/github-ssh-key?label=pypi%20downloads)](https://pypi.org/project/github-ssh-key/)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/smartlegionlab/github-ssh-key)](https://github.com/smartlegionlab/github-ssh-key/)
+[![GitHub](https://img.shields.io/github/license/smartlegionlab/github-ssh-key)](https://github.com/smartlegionlab/github-ssh-key/blob/master/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/github-ssh-key)](https://pypi.org/project/github-ssh-key)
+[![PyPI - Format](https://img.shields.io/pypi/format/github-ssh-key)](https://pypi.org/project/github-ssh-key)
+[![GitHub Repo stars](https://img.shields.io/github/stars/smartlegionlab/github-ssh-key?style=social)](https://github.com/smartlegionlab/github-ssh-key/)
+[![GitHub watchers](https://img.shields.io/github/watchers/smartlegionlab/github-ssh-key?style=social)](https://github.com/smartlegionlab/github-ssh-key/)
+[![GitHub forks](https://img.shields.io/github/forks/smartlegionlab/github-ssh-key?style=social)](https://github.com/smartlegionlab/github-ssh-key/)
+
+***
+
+Author and developer: ___A.A Suvorov___
+
+***
+
+## Supported:
+
+- Linux: All.
+- Termux (Android).
+
+***
+
+## Images:
+
+![logo](https://github.com/smartlegionlab/github-ssh-key/raw/master/data/images/github-ssh-key.png)
+
+***
+
+## What's new?
+
+### ___github-ssh-key v0.3.0___
+
+- Improved work with help, added the ability to run commands directly from help.
+- Improved interface.
+
+***
+
+## Description:
+
+___github-ssh-key___ - GitHub ssh key manager. Console utility for creating, getting, 
+testing, using public ssh keys for GitHub.
+
+Possibilities:
+
+- Convenient interactive menu.
+- Generating ssh keys for GitHub.
+- Output ssh key to the console.
+- Adding ssh key to GitHub.
+- Checking the ssh key, testing the connection.
+- Interactive menu for working with the utility.
+- Interactive menu for help.
+- Launch the default browser with a page for adding ssh key on GitHub.
+- Cloning private repositories via ssh.
+- Running individual commands.
+
+***
+
+## Help:
+
+### Install and use:
+
+#### Install:
+
+`pip install github-ssh-key`
+
+`github-ssh-key`
+
+#### Use:
+
+To access GitHub over ssh, you should run some sequence of actions.
+
+- Install openssh;
+- Generate new ssh keys;
+- Copy the public key;
+- Add your public key to GitHub;
+- Check the connection;
+
+This utility provides you with these capabilities.
+
+Adding a key to your GitHub account involves several steps:
+
+1. Generating new ssh key.
+   - Install openssh, or make sure you have it installed with the ssh command.
+   - During the generation process, enter your email that you use when working with GitHub.
+   - Do not change the default file name.
+   - Don't set a passphrase if you don't want to enter it every time.
+2. Copying ssh key.
+   - Highlight and completely copy your ssh key.
+3. Adding ssh key to your GitHub account.
+   - Highlight and completely copy your ssh key.
+   - Add your ssh key to your GitHub account.
+4. Testing the ssh key (Testing the connection).
+   - For a successful connection, you had to follow these steps:
+     - Generate ssh key.
+     - Highlight and completely copy your ssh key.
+     - Add ssh key to your GitHub account.
+     - If you did everything correctly, you will see a personalized greeting.
+
+Also, directly from the interactive menu, you can clone your private
+repository using ssh.
+
+To get help with commands, use:
+
+`github-ssh-key [command] -h`
+
+`github-ssh-key new -h`
+`github-ssh-key show -h`
+`github-ssh-key add -h`
+`github-ssh-key test -h`
+`github-ssh-key clone -h`
+`github-ssh-key help -h`
+
+#### Commands:
+
+`github-ssh-key [command] [args]`
+
+- run `github-ssh-key run`
+- new `github-ssh-key new -e [your email]`
+- show `github-ssh-key show`
+- add `github-ssh-key add`
+- test `github-ssh-key test`
+- clone `github-ssh-key clone -l [GitHub login] -n [repo name]`
+
+
+#### Variant 1:
+
+- Go to the project folder
+- `python setup.py install`
+- `github-ssh-key`
+
+#### Variant 2:
+
+- Install [python](https://python.org)
+- Go to the project folder
+- `pip install -r requirements.txt`
+- `python github-ssh-key.py`
+
+***
+
+## Disclaimer of liability:
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+***
+
+## Copyright:
+    --------------------------------------------------------
+    Licensed under the terms of the BSD 3-Clause License
+    (see LICENSE for details).
+    Copyright © 2018-2024, A.A Suvorov
+    All rights reserved.
+    --------------------------------------------------------

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-architect

github-ssh-key.py

@@ -0,0 +1,12 @@
+# --------------------------------------------------------
+# Licensed under the terms of the BSD 3-Clause License
+# (see LICENSE for details).
+# Copyright © 2018-2024, A.A Suvorov
+# All rights reserved.
+# --------------------------------------------------------
+# https://github.com/smartlegionlab
+# --------------------------------------------------------
+from github_ssh_key.app import cli
+
+if __name__ == '__main__':
+    cli()

github_ssh_key/__init__.py

@@ -0,0 +1,10 @@
+# --------------------------------------------------------
+# Licensed under the terms of the BSD 3-Clause License
+# (see LICENSE for details).
+# Copyright © 2018-2024, A.A Suvorov
+# All rights reserved.
+# --------------------------------------------------------
+# https://github.com/smartlegionlab
+# --------------------------------------------------------
+"""GitHub ssh key manager."""
+__version__ = '0.4.0'

github_ssh_key/app.py

@@ -0,0 +1,80 @@
+# --------------------------------------------------------
+# Licensed under the terms of the BSD 3-Clause License
+# (see LICENSE for details).
+# Copyright © 2018-2024, A.A Suvorov
+# All rights reserved.
+# --------------------------------------------------------
+# https://github.com/smartlegionlab
+# --------------------------------------------------------
+import click
+
+from github_ssh_key.manager import CliManager
+
+
+@click.group(
+    invoke_without_command=True,
+    context_settings={'help_option_names': ['-h', '--help']},
+)
+@click.version_option(f'{CliManager.name} v{CliManager.version}')
+@click.pass_context
+def cli(ctx):
+    """
+    GitHub ssh key manager.
+
+    Copyright © 2018-2024, A.A Suvorov; All rights reserved.
+
+    https://github.com/smartlegionlab/
+
+    """
+    CliManager.show_head()
+    if ctx.invoked_subcommand is None:
+        CliManager.commander.run()
+
+
+@cli.command(name='run')
+def run():
+    """Run Main menu."""
+    CliManager.commander.run()
+
+
+@cli.command(name='new')
+@click.option('-e', 'email', type=click.STRING, default=None, help='Your email used on GitHub')
+def new_key(email):
+    """Create new public ssh keys."""
+    CliManager.commander.new_key(email=email)
+
+
+@cli.command(name='test')
+def test_key():
+    """Test your public ssh keys."""
+    CliManager.commander.test_key()
+
+
+@cli.command(name='show')
+def show_key():
+    """Show your public ssh keys."""
+    CliManager.commander.show_key()
+
+
+@cli.command(name='clone')
+@click.option('-l', '--login', type=click.STRING, help='GitHub login', default=None)
+@click.option('-n', '--name', type=click.STRING, help='Repo name', default=None)
+def clone_repo(login, name):
+    """Clone your GitHub repository using ssh."""
+    CliManager.commander.clone_repo(login=login, repo_name=name)
+
+
+@cli.command(name='add')
+def add_key():
+    """Open https://github.com/settings/keys in default browser"""
+    CliManager.commander.add_key()
+
+
+@cli.result_callback()
+def process_result(result):
+    """Process result"""
+    CliManager.show_footer()
+
+
+if __name__ == '__main__':
+    cli()