https://github.com/sorend/sshconf

SSH configuration reading and modification library in Python
https://github.com/sorend/sshconf

Last synced: 3 days ago
JSON representation

SSH configuration reading and modification library in Python

• Host: GitHub
• URL: https://github.com/sorend/sshconf
• Owner: sorend
• License: mit
• Created: 2017-01-21T07:17:55.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-01T03:14:59.000Z (4 months ago)
• Last Synced: 2024-10-12T04:44:36.038Z (24 days ago)
• Language: Python
• Size: 78.1 KB
• Stars: 90
• Watchers: 5
• Forks: 20
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - sshconf
• awesome-starts - sorend/sshconf - SSH configuration reading and modification library in Python (others)

README

        

sshconf

===========

[![PyPI version](https://badge.fury.io/py/sshconf.svg)](https://pypi.org/project/sshconf/)

[![Build Status](https://github.com/sorend/sshconf/actions/workflows/build.yaml/badge.svg)](https://github.com/sorend/sshconf/actions/workflows/build.yaml)

[![codecov](https://codecov.io/gh/sorend/sshconf/branch/master/graph/badge.svg)](https://codecov.io/gh/sorend/sshconf)

Sshconf is a library for reading and modifying your ssh/config file in a non-intrusive way, meaning

your file should look more or less the same after modifications. Idea is to keep it simple,

so you can modify it for your needs.

Read more about ssh config files here: [Create SSH config file on Linux](https://www.cyberciti.biz/faq/create-ssh-config-file-on-linux-unix/)

Installation and usage

---------------------------

Install through pip is the most easy way. You can install from the Git source directly:

```bash

pip install sshconf

```

Below is some example use:

```python

from sshconf import read_ssh_config, empty_ssh_config_file

from os.path import expanduser

c = read_ssh_config(expanduser("~/.ssh/config"))

print("hosts", c.hosts())

# assuming you have a host "svu"

print("svu host", c.host("svu"))  # print the settings

c.set("svu", Hostname="ssh.svu.local", Port=1234)

print("svu host now", c.host("svu"))

c.unset("svu", "port")

print("svu host now", c.host("svu"))

c.add("newsvu", Hostname="ssh-new.svu.local", Port=22, User="stud1234",

                RemoteForward=["localhost:2022 localhost:22", "localhost:2025 localhost:25"])

print("newsvu", c.host("newsvu"))

c.add("oldsvu", before_host="newsvu", Hostname="ssh-old.svu.local", Port=22, User="Stud1234")

c.rename("newsvu", "svu-new")

print("svu-new", c.host("svu-new"))

# overwrite existing file(s)

c.save()

# write all to a new file

c.write(expanduser("~/.ssh/newconfig"))

# creating a new config file.

c2 = empty_ssh_config_file()

c2.add("svu", Hostname="ssh.svu.local", User="teachmca", Port=22)

c2.write("newconfig")

c2.remove("svu")  # remove

```

A few things to note:

- `save()` overwrites the files you read from.

- `write()` writes a new config file. If you used `Include` in the read configuration, output will contain everything in one file.

- indent for new lines is auto-probed from existing config lines, and defaults to two spaces.

About

-----

sshconf is created at the Department of Computer Science at Sri Venkateswara University, Tirupati, INDIA by a student as part of his projects.