Skip to main content

PyCharmSync is a simple tool for uploading changed project files to a remote host, about as soon as they change.

Project description


A simple tool for uploading changed project files to a remote host, automatically.

Paid versions of PyCharm can be set up to upload project files as you change them locally. PyCharmSync aims to do just that using the sshpass and the scp command on Unix based machines.

PyCharmSync will watch a project directory, track the files in the directory and then upload the changed versions automatically based on settings set in an .env file in your root project directory.


pip install PyCharmSync

.env Example

Here are some settings for a project named project_name on a raspberry pi. The .env file should be consumable by configparser.ConfigParser

USER = pi
PASS = raspberry
PROJECT_ROOT = /home/pi/project_name

The settings laid out above would map to the following command:



sshpass -p "raspberry" scp /home/user/project_name/ pi@

Usage Example

Once you have your .env file configured in your project's root directory all you need to do is import ProjectSync from PyCharmSync and then run it's main method:

from PyCharmSync import ProjectSync


If you are not running the main method from your project's root directory you need to pass a cwd to the main method.

from PyCharmSync import ProjectSync


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

PyCharmSync-0.0.2.tar.gz (2.9 kB view hashes)

Uploaded source

Built Distribution

PyCharmSync-0.0.2-py3-none-any.whl (3.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page