Skip to main content

Lightweight SSH config library.

Project description


PyPi version Build Status codecov

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

Installation and usage

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

pip install sshconf

Below is some example use:

from __future__ import print_function
from sshconf import read_ssh_config, empty_ssh_config
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","svu"))  # print the settings
c.set("svu", Hostname="ssh.svu.local", Port=1234)
print("svu host now","svu"))
c.unset("svu", "port")
print("svu host now","svu"))

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

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

# overwrite existing file(s)

# write all to a new file

# creating a new config file.
c2 = empty_ssh_config_file()
c2.add("svu", Hostname="ssh.svu.local", User="teachmca", Port=22)

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.


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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sshconf-0.2.5.tar.gz (10.4 kB view hashes)

Uploaded source

Built Distribution

sshconf-0.2.5-py3-none-any.whl (6.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page