Metadata-Version: 2.1
Name: ssh-config-json
Version: 0.1.0
Summary: Dump JSON for your ssh config include IdentityFiles and restore those.
Home-page: https://github.com/tubone24/ssh_config_json
Author: tubone24
Author-email: tubo.yyyuuu@gmail.com
License: MIT
Project-URL: Documentation, https://github.com/tubone24/ssh_config_json
Project-URL: ProjectBlog, https://blog.tubone-project24.xyz
Keywords: ssh-config,json,backup
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >= 3.6
Requires-Dist: paramiko (==2.7.2)
Requires-Dist: docopt (==0.6.2)
Provides-Extra: develop
Requires-Dist: black (==19.10b0) ; extra == 'develop'
Requires-Dist: pytest (==5.2.3) ; extra == 'develop'
Requires-Dist: pytest-cov (==2.7.1) ; extra == 'develop'
Requires-Dist: pytest-pythonpath (==0.7.3) ; extra == 'develop'
Requires-Dist: flake8 (==3.7.7) ; extra == 'develop'
Requires-Dist: pep8 (==1.7.1) ; extra == 'develop'
Requires-Dist: pyflakes (==2.1.1) ; extra == 'develop'
Requires-Dist: pytest-flake8 (==1.0.4) ; extra == 'develop'
Requires-Dist: pytest-pep8 (==1.0.6) ; extra == 'develop'
Requires-Dist: coverage (==4.5.4) ; extra == 'develop'
Requires-Dist: twine (==3.2.0) ; extra == 'develop'
Requires-Dist: wheel (==0.35.1) ; extra == 'develop'
Provides-Extra: docs
Requires-Dist: mkdocs (==1.1.2) ; extra == 'docs'

===============
SSH Config JSON
===============

``SSH Config JSON`` is dumping JSON for your ssh config include IdentityFiles and restoring those.

------

.. image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat
   :target: https://github.com/tubone24/ebook_homebrew/blob/master/LICENSE
   :alt: LICENSE

.. image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
   :target: http://makeapullrequest.com
   :alt: PR Welcomes

.. image:: https://github.com/tubone24/ssh_config_json/workflows/TestingPythonPackage/badge.svg
   :target: https://github.com/tubone24/ssh_config_json/actions?query=workflow%3ATestingPythonPackage
   :alt: GitHub Actions

.. image:: https://coveralls.io/repos/github/tubone24/ssh_config_json/badge.svg?branch=main
   :target: https://coveralls.io/github/tubone24/ssh_config_json?branch=main
   :alt: Coverage

Getting Started
===============

``SSH Config JSON`` uses ``The Python Package Index(Pypi)``, so that you can use ``pip`` installer.

pip installer
----------------------

.. code-block:: bash

   $ pip install xxxxxx

Usage
=====

You can use global command ``scj`` .

Show help.

.. code-block:: bash

   $ scj -h
   SSH Config JSON
   Overview:
     Dump JSON for your ssh config include IdentityFiles and restore those.

   Usage:
     scj [-h|--help] [-v|--version]
     scj dump <file> [-c|--config=<config>] [-i|--identityFile]
     scj restore <file> [-c|--config=<config>] [-i|--identityFile]

   Options:
     dump                       : dump SSH Config file to JSON
     restore                    : Restore SSH Config file from JSON
     <file>                     : Dumped json file
     -h, --help                 : Help
     -v, --version              : Show version
     -c, --config=<config>      : Specific SSH Config file path [default: ~/.ssh/config]
     -i, --identityFile         : Include IdentityFiles

Ex1) Dump your SSH Config to JSON

.. code-block:: bash

   $ scj dump dump_config.json

Ex2) Dump your SSH Config to JSON with IdentityFiles

.. code-block:: bash

   $ scj dump dump_config.json -i

Ex3) Restore JSON to SSH Config

.. code-block:: bash

   $ scj restore dump_config.json

Ex4) Restore JSON to SSH Config with IdentityFiles

.. code-block:: bash

   $ scj restore dump_config.json -i

Testing
=======

Unit Test
---------

Using pytest, if you want to unit testing.

.. code-block:: bash

   $ pytest

If you want to get coverage report, run coverage and check the report.

.. code-block:: bash

   $ coverage run --source=ssh_config_json -m pytest
   $ coverage report -m

Integration Test
----------------

Using pytest, if you want to do integrated tests with mark "--it".

.. code-block:: bash

   $ pytest --it

With tox
--------

With tox, you can test multiple python version.(only python 3.6, 3.7, 3.8)

.. code-block:: bash

   $ tox

Licence
=======

This software is released under the MIT License, see LICENSE.

