https://github.com/hackersandslackers/paramiko-tutorial

📡🐍 SSH & SCP in Python with Paramiko
https://github.com/hackersandslackers/paramiko-tutorial

network-automation paramiko python scp ssh-client tutorial

Last synced: 6 months ago
JSON representation

📡🐍 SSH & SCP in Python with Paramiko

• Host: GitHub
• URL: https://github.com/hackersandslackers/paramiko-tutorial
• Owner: hackersandslackers
• License: mit
• Created: 2019-10-08T03:40:05.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2025-03-17T17:49:40.000Z (7 months ago)
• Last Synced: 2025-03-28T21:09:10.417Z (6 months ago)
• Topics: network-automation, paramiko, python, scp, ssh-client, tutorial
• Language: Python
• Homepage: https://hackersandslackers.com/ssh-scp-in-python-with-paramiko/
• Size: 6.61 MB
• Stars: 116
• Watchers: 8
• Forks: 51
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Paramiko SSH & SCP Tutorial

![Python](https://img.shields.io/badge/Python-v^3.9-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a)

![Paramiko](https://img.shields.io/badge/Paramiko-v^2.11-blue.svg?longCache=true&logo=python&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)

![SCP](https://img.shields.io/badge/SCP-v^0.14-blue.svg?longCache=true&logo=python&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a)

![GitHub Last Commit](https://img.shields.io/github/last-commit/google/skia.svg?style=flat-square&colorA=4c566a&colorB=a3be8c&logo=GitHub)

[![GitHub Issues](https://img.shields.io/github/issues/hackersandslackers/paramiko-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/paramiko-tutorial/issues)

[![GitHub Stars](https://img.shields.io/github/stars/hackersandslackers/paramiko-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/paramiko-tutorial/stargazers)

[![GitHub Forks](https://img.shields.io/github/forks/hackersandslackers/paramiko-tutorial.svg?style=flat-square&colorA=4c566a&logo=GitHub&colorB=ebcb8b)](https://github.com/hackersandslackers/paramiko-tutorial/network)

![Paramiko Tutorial](./.github/paramiko@2x.jpg)

Source code for the accompanying tutorial found here: https://hackersandslackers.com/ssh-scp-in-python-with-paramiko/

## Getting Started

### Installation

```shell

$ git clone https://github.com/hackersandslackers/paramiko-tutorial.git

$ cd paramiko-tutorial

$ make install

$ make run

```

### Configuration

Replace the values in **.env.example** with your values and rename this file to **.env**:

* `ENVIRONMENT`: Contextual environment the script is being on.

* `SSH_REMOTE_HOST`: IP address (or URL) of remote host to SSH into.

* `SSH_USERNAME`: Username for connecting to remote host.

* `SSH_PASSWORD` _(optional)_: Password of user SSHing into remote host via basic auth.

* `SSH_KEY_FILEPATH`: /path/to/local/sshkey

* `SCP_DESTINATION_FOLDER` _(optional)_: Remote directory to serve as destination for file uploads.

*Remember to never commit secrets saved in .env files to Github.*

-----

**Hackers and Slackers** tutorials are free of charge. If you found this tutorial helpful, a [small donation](https://www.buymeacoffee.com/hackersslackers) would be greatly appreciated to keep us in business. All proceeds go towards coffee, and all coffee goes towards more content.